diff --git a/.github/workflows/swift.yml b/.github/workflows/swift.yml index ab6e9f0..e0575e4 100644 --- a/.github/workflows/swift.yml +++ b/.github/workflows/swift.yml @@ -2,31 +2,47 @@ name: Swift on: push: - branches: [master] + branches: [master, main] pull_request: - branches: [master] + branches: [master, main] + workflow_dispatch: + +permissions: + contents: read -#list of jobs to perform jobs: - #the only job in the list, named `build` - build_and_test: - #specify OS to run the jobs on - runs-on: macos-latest - #sequential steps to run for the `build` job + spm: + name: Swift package + runs-on: macos-15 + steps: + - uses: actions/checkout@v4 + - name: Validate package manifest + run: swift package dump-package + - name: Build package and test targets with Swift 6 + run: | + SDK_PATH="$(xcrun --sdk iphonesimulator --show-sdk-path)" + swift build --build-tests \ + --sdk "$SDK_PATH" \ + --triple arm64-apple-ios17.0-simulator \ + -Xswiftc -swift-version -Xswiftc 6 + + example: + name: SPM example and tests + runs-on: macos-15 steps: - # step 1, use Marketplace action called Checkout@v2, to checkout the code - - uses: actions/checkout@v2 #'uses' keyword launches the Marketplace action - # step 2, verbosely build the package using the `swift` CLI - - name: Build - run: swift build -v #'run' keyword executes the command, as if it's run in terminal - # step 3, run tests - # Note that you must use "=" and not ":" despite error logs for -destiation using ":" - # Also using "Any iOS Simulator" doesn't seem to work despite being an option. - # The using CODE_SIGN... and beyond are for Codecov purposes when generating results. - - name: Run tests - run: | - cd Example - pod install - xcodebuild clean test -scheme OSSSpeechKit-Example -workspace OSSSpeechKit.xcworkspace -destination 'platform=iOS Simulator,OS=16.2,name=iPhone 14' CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO ONLY_ACTIVE_ARCH=NO - bash <(curl https://codecov.io/bash | sed 's/"$beta_xcode_partials"//g') + - uses: actions/checkout@v4 + - name: Select an available iPhone simulator + run: | + SIMULATOR_ID="$( + xcrun simctl list devices available -j | + python3 -c 'import json, sys; data=json.load(sys.stdin); print(next(device["udid"] for devices in data["devices"].values() for device in devices if device["name"].startswith("iPhone")))' + )" + echo "SIMULATOR_DESTINATION=platform=iOS Simulator,id=${SIMULATOR_ID}" >> "$GITHUB_ENV" + - name: Test example and package + run: | + xcodebuild test \ + -project Example/OSSSpeechKit.xcodeproj \ + -scheme OSSSpeechKit-Example \ + -destination "$SIMULATOR_DESTINATION" \ + CODE_SIGNING_ALLOWED=NO diff --git a/.gitignore b/.gitignore index 10b753d..1dcd187 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,3 @@ -Example/Pods +.build/ *.xcuserstate *.xcbkptlist diff --git a/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata b/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..919434a --- /dev/null +++ b/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/.swiftpm/xcode/xcuserdata/supermac.xcuserdatad/xcschemes/xcschememanagement.plist b/.swiftpm/xcode/xcuserdata/supermac.xcuserdatad/xcschemes/xcschememanagement.plist new file mode 100644 index 0000000..eca45ad --- /dev/null +++ b/.swiftpm/xcode/xcuserdata/supermac.xcuserdatad/xcschemes/xcschememanagement.plist @@ -0,0 +1,27 @@ + + + + + SchemeUserState + + OSSSpeechKit.xcscheme_^#shared#^_ + + orderHint + 0 + + + SuppressBuildableAutocreation + + OSSSpeechKit + + primary + + + OSSSpeechKitTests + + primary + + + + + diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 226f4cc..0000000 --- a/.travis.yml +++ /dev/null @@ -1,23 +0,0 @@ -# Check Travis CI version info: -# https://docs.travis-ci.com/user/reference/osx/ -language: objective-c -osx_image: xcode14.2 -xcode_workspace: OSSSpeechKit.xcworkspace -xcode_scheme: OSSSpeechKit-Example -xcode_destination: platform=iOS Simulator,OS=16.2,name=iPhone 14 -before_install: - - cd Example - - pod install -after_success: - # - bash <(curl -s https://codecov.io/bash) - # Fixing code cov issue with solution from https://community.codecov.io/t/llvm-cov-failed-to-produce-results-for/1652/9 - - bash <(curl https://codecov.io/bash | sed 's/"$beta_xcode_partials"//g') - - gem install jazzy - - make documentation -# deploy: -# provider: pages -# cleanup: false -# github-token: $GH_TOKEN # Set in the settings page of your repository, as a secure variable -# local-dir: docs -# on: -# branch: master diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..41d6bc9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,36 @@ +# Changelog + +All notable changes to OSSSpeechKit are documented here. + +The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and releases use [Semantic Versioning](https://semver.org/). + +## [1.0.0] - 2026-07-13 + +### Added + +- `OSSSpeechEngine`, an instance-based async API for synthesis and recognition. +- `OSSLanguage` runtime-aware language metadata and catalog. +- `OSSVoiceConfiguration` and `OSSUtteranceConfiguration` value types. +- Unicode `flagEmoji` and on-demand UIKit flag rendering. +- Swift Package Manager support for every source under `OSSSpeechKit/Classes`. +- A privacy manifest for the SDK's data practices. + +### Changed + +- Raised the minimum deployment target to iOS 17. +- Made Swift Package Manager the sole supported installation path. +- Modernized continuous integration for package and example tests. +- Limited published package products and platform frameworks to the supported iOS library. + +### Deprecated + +- `OSSSpeech` and its shared singleton in favor of `OSSSpeechEngine`. +- `OSSVoice` in favor of `OSSVoiceConfiguration`. +- `OSSUtterance` in favor of `OSSUtteranceConfiguration`. +- Legacy `OSSVoiceEnum` catalog and image flag access in favor of `OSSLanguage`. + +### Removed + +- CocoaPods distribution and contributor tooling. The historical `0.3.3` pod remains resolvable but is unsupported; version 1.0 and later are available only through Swift Package Manager. + +[1.0.0]: https://github.com/AppDevGuy/OSSSpeechKit/releases/tag/1.0.0 diff --git a/Example/OSSSpeechKit.xcodeproj/project.pbxproj b/Example/OSSSpeechKit.xcodeproj/project.pbxproj index 969bc43..7255789 100644 --- a/Example/OSSSpeechKit.xcodeproj/project.pbxproj +++ b/Example/OSSSpeechKit.xcodeproj/project.pbxproj @@ -3,21 +3,28 @@ archiveVersion = 1; classes = { }; - objectVersion = 54; + objectVersion = 60; objects = { /* Begin PBXBuildFile section */ 607FACD61AFB9204008FA782 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 607FACD51AFB9204008FA782 /* AppDelegate.swift */; }; 607FACDD1AFB9204008FA782 /* Images.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 607FACDC1AFB9204008FA782 /* Images.xcassets */; }; 607FACE01AFB9204008FA782 /* LaunchScreen.xib in Resources */ = {isa = PBXBuildFile; fileRef = 607FACDE1AFB9204008FA782 /* LaunchScreen.xib */; }; - 64EA52AEB7F1C16E3DA6FF13 /* Pods_OSSSpeechKit_Example.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 72EC396A97B53B0AF569DE1A /* Pods_OSSSpeechKit_Example.framework */; }; + A10000000000000000000001 /* ModernOSSSpeechTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = A10000000000000000000002 /* ModernOSSSpeechTests.swift */; }; B042F2D1245FC24100958719 /* LocalizableTests.strings in Resources */ = {isa = PBXBuildFile; fileRef = B042F2D0245FC24100958719 /* LocalizableTests.strings */; }; B042F2D4245FEDC600958719 /* SFSpeechRecognizerMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = B042F2D3245FEDC600958719 /* SFSpeechRecognizerMock.swift */; }; B042F2D5245FEDC600958719 /* SFSpeechRecognizerMock.swift in Sources */ = {isa = PBXBuildFile; fileRef = B042F2D3245FEDC600958719 /* SFSpeechRecognizerMock.swift */; }; B04ABC992458500100ACE8F2 /* CountryLanguageTableViewCell.swift in Sources */ = {isa = PBXBuildFile; fileRef = B04ABC982458500100ACE8F2 /* CountryLanguageTableViewCell.swift */; }; B04ABC9B2458502C00ACE8F2 /* CountryLanguageListTableViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = B04ABC9A2458502C00ACE8F2 /* CountryLanguageListTableViewController.swift */; }; B06260E122ABCA2600069801 /* OSSSpeechTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = B06260E022ABCA2600069801 /* OSSSpeechTests.swift */; }; - E95D80055602E1F3DAB44DDC /* Pods_OSSSpeechKit_Tests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 59EABFEDF2B45A65EB1CA76E /* Pods_OSSSpeechKit_Tests.framework */; }; + B74DEBAA3004E0B100D7FB43 /* OSSSpeechKit in Frameworks */ = {isa = PBXBuildFile; productRef = B74DEBA93004E0B100D7FB43 /* OSSSpeechKit */; }; + B74DEBAC3004E0BA00D7FB43 /* OSSSpeechKit in Frameworks */ = {isa = PBXBuildFile; productRef = B74DEBAB3004E0BA00D7FB43 /* OSSSpeechKit */; }; + C10000000000000000000001 /* SceneDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = C10000000000000000000002 /* SceneDelegate.swift */; }; + D10000000000000000000001 /* RecordingSessionViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = D10000000000000000000002 /* RecordingSessionViewController.swift */; }; + D10000000000000000000003 /* RecordingSessionModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = D10000000000000000000004 /* RecordingSessionModel.swift */; }; + D10000000000000000000005 /* RecordingSessionModel.swift in Sources */ = {isa = PBXBuildFile; fileRef = D10000000000000000000004 /* RecordingSessionModel.swift */; }; + D10000000000000000000006 /* RecordingSessionModelTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D10000000000000000000007 /* RecordingSessionModelTests.swift */; }; + D10000000000000000000008 /* LocalizableTests.strings in Resources */ = {isa = PBXBuildFile; fileRef = D10000000000000000000009 /* LocalizableTests.strings */; }; /* End PBXBuildFile section */ /* Begin PBXContainerItemProxy section */ @@ -32,7 +39,6 @@ /* Begin PBXFileReference section */ 114BED23C01C7E7FB30AFBFA /* README.md */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = net.daringfireball.markdown; name = README.md; path = ../README.md; sourceTree = ""; }; - 59EABFEDF2B45A65EB1CA76E /* Pods_OSSSpeechKit_Tests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_OSSSpeechKit_Tests.framework; sourceTree = BUILT_PRODUCTS_DIR; }; 607FACD01AFB9204008FA782 /* OSSSpeechKit_Example.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = OSSSpeechKit_Example.app; sourceTree = BUILT_PRODUCTS_DIR; }; 607FACD41AFB9204008FA782 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; 607FACD51AFB9204008FA782 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; @@ -40,18 +46,18 @@ 607FACDF1AFB9204008FA782 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.xib; name = Base; path = Base.lproj/LaunchScreen.xib; sourceTree = ""; }; 607FACE51AFB9204008FA782 /* OSSSpeechKit_Tests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = OSSSpeechKit_Tests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; 607FACEA1AFB9204008FA782 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; - 68AF1DA5BE256D75F68CD361 /* OSSSpeechKit.podspec */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text; name = OSSSpeechKit.podspec; path = ../OSSSpeechKit.podspec; sourceTree = ""; xcLanguageSpecificationIdentifier = xcode.lang.ruby; }; - 72EC396A97B53B0AF569DE1A /* Pods_OSSSpeechKit_Example.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_OSSSpeechKit_Example.framework; sourceTree = BUILT_PRODUCTS_DIR; }; - 8E50A387E6C9227B46CD07D5 /* Pods-OSSSpeechKit_Tests.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OSSSpeechKit_Tests.debug.xcconfig"; path = "Target Support Files/Pods-OSSSpeechKit_Tests/Pods-OSSSpeechKit_Tests.debug.xcconfig"; sourceTree = ""; }; - 969F0DB7618212626605C72B /* Pods-OSSSpeechKit_Example.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OSSSpeechKit_Example.release.xcconfig"; path = "Target Support Files/Pods-OSSSpeechKit_Example/Pods-OSSSpeechKit_Example.release.xcconfig"; sourceTree = ""; }; + A10000000000000000000002 /* ModernOSSSpeechTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ModernOSSSpeechTests.swift; sourceTree = ""; }; AD7924CA4244888FD94ED9C6 /* LICENSE */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text; name = LICENSE; path = ../LICENSE; sourceTree = ""; }; B042F2D0245FC24100958719 /* LocalizableTests.strings */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.strings; path = LocalizableTests.strings; sourceTree = ""; }; B042F2D3245FEDC600958719 /* SFSpeechRecognizerMock.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SFSpeechRecognizerMock.swift; sourceTree = ""; }; B04ABC982458500100ACE8F2 /* CountryLanguageTableViewCell.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CountryLanguageTableViewCell.swift; sourceTree = ""; }; B04ABC9A2458502C00ACE8F2 /* CountryLanguageListTableViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CountryLanguageListTableViewController.swift; sourceTree = ""; }; B06260E022ABCA2600069801 /* OSSSpeechTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OSSSpeechTests.swift; sourceTree = ""; }; - D9904FC64C70B4667E482942 /* Pods-OSSSpeechKit_Example.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OSSSpeechKit_Example.debug.xcconfig"; path = "Target Support Files/Pods-OSSSpeechKit_Example/Pods-OSSSpeechKit_Example.debug.xcconfig"; sourceTree = ""; }; - EB2636A7260A79C428DB0FCF /* Pods-OSSSpeechKit_Tests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-OSSSpeechKit_Tests.release.xcconfig"; path = "Target Support Files/Pods-OSSSpeechKit_Tests/Pods-OSSSpeechKit_Tests.release.xcconfig"; sourceTree = ""; }; + C10000000000000000000002 /* SceneDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SceneDelegate.swift; sourceTree = ""; }; + D10000000000000000000002 /* RecordingSessionViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RecordingSessionViewController.swift; sourceTree = ""; }; + D10000000000000000000004 /* RecordingSessionModel.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RecordingSessionModel.swift; sourceTree = ""; }; + D10000000000000000000007 /* RecordingSessionModelTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RecordingSessionModelTests.swift; sourceTree = ""; }; + D10000000000000000000009 /* LocalizableTests.strings */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; path = LocalizableTests.strings; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -59,7 +65,7 @@ isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; files = ( - 64EA52AEB7F1C16E3DA6FF13 /* Pods_OSSSpeechKit_Example.framework in Frameworks */, + B74DEBAC3004E0BA00D7FB43 /* OSSSpeechKit in Frameworks */, ); runOnlyForDeploymentPostprocessing = 0; }; @@ -67,42 +73,21 @@ isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; files = ( - E95D80055602E1F3DAB44DDC /* Pods_OSSSpeechKit_Tests.framework in Frameworks */, + B74DEBAA3004E0B100D7FB43 /* OSSSpeechKit in Frameworks */, ); runOnlyForDeploymentPostprocessing = 0; }; /* End PBXFrameworksBuildPhase section */ /* Begin PBXGroup section */ - 46FCF8F1DCF41A9F227DB736 /* Pods */ = { - isa = PBXGroup; - children = ( - D9904FC64C70B4667E482942 /* Pods-OSSSpeechKit_Example.debug.xcconfig */, - 969F0DB7618212626605C72B /* Pods-OSSSpeechKit_Example.release.xcconfig */, - 8E50A387E6C9227B46CD07D5 /* Pods-OSSSpeechKit_Tests.debug.xcconfig */, - EB2636A7260A79C428DB0FCF /* Pods-OSSSpeechKit_Tests.release.xcconfig */, - ); - path = Pods; - sourceTree = ""; - }; - 5F6BD5C16B6F66B83078BEFD /* Frameworks */ = { - isa = PBXGroup; - children = ( - 72EC396A97B53B0AF569DE1A /* Pods_OSSSpeechKit_Example.framework */, - 59EABFEDF2B45A65EB1CA76E /* Pods_OSSSpeechKit_Tests.framework */, - ); - name = Frameworks; - sourceTree = ""; - }; 607FACC71AFB9204008FA782 = { isa = PBXGroup; children = ( - 607FACF51AFB993E008FA782 /* Podspec Metadata */, + 607FACF51AFB993E008FA782 /* Project Metadata */, 607FACD21AFB9204008FA782 /* Example for OSSSpeechKit */, 607FACE81AFB9204008FA782 /* Tests */, + B74DEBA83004E0B100D7FB43 /* Frameworks */, 607FACD11AFB9204008FA782 /* Products */, - 46FCF8F1DCF41A9F227DB736 /* Pods */, - 5F6BD5C16B6F66B83078BEFD /* Frameworks */, ); sourceTree = ""; }; @@ -120,7 +105,10 @@ children = ( B005BA2722A942EF0030E2F4 /* Subviews */, 607FACD51AFB9204008FA782 /* AppDelegate.swift */, + C10000000000000000000002 /* SceneDelegate.swift */, B04ABC9A2458502C00ACE8F2 /* CountryLanguageListTableViewController.swift */, + D10000000000000000000004 /* RecordingSessionModel.swift */, + D10000000000000000000002 /* RecordingSessionViewController.swift */, 607FACDC1AFB9204008FA782 /* Images.xcassets */, 607FACDE1AFB9204008FA782 /* LaunchScreen.xib */, 607FACD31AFB9204008FA782 /* Supporting Files */, @@ -143,6 +131,8 @@ children = ( 607FACE91AFB9204008FA782 /* Supporting Files */, B06260E022ABCA2600069801 /* OSSSpeechTests.swift */, + A10000000000000000000002 /* ModernOSSSpeechTests.swift */, + D10000000000000000000007 /* RecordingSessionModelTests.swift */, ); path = Tests; sourceTree = ""; @@ -152,18 +142,18 @@ children = ( 607FACEA1AFB9204008FA782 /* Info.plist */, B042F2D3245FEDC600958719 /* SFSpeechRecognizerMock.swift */, + D10000000000000000000009 /* LocalizableTests.strings */, ); name = "Supporting Files"; sourceTree = ""; }; - 607FACF51AFB993E008FA782 /* Podspec Metadata */ = { + 607FACF51AFB993E008FA782 /* Project Metadata */ = { isa = PBXGroup; children = ( - 68AF1DA5BE256D75F68CD361 /* OSSSpeechKit.podspec */, 114BED23C01C7E7FB30AFBFA /* README.md */, AD7924CA4244888FD94ED9C6 /* LICENSE */, ); - name = "Podspec Metadata"; + name = "Project Metadata"; sourceTree = ""; }; B005BA2722A942EF0030E2F4 /* Subviews */ = { @@ -174,6 +164,13 @@ name = Subviews; sourceTree = ""; }; + B74DEBA83004E0B100D7FB43 /* Frameworks */ = { + isa = PBXGroup; + children = ( + ); + name = Frameworks; + sourceTree = ""; + }; /* End PBXGroup section */ /* Begin PBXNativeTarget section */ @@ -181,11 +178,9 @@ isa = PBXNativeTarget; buildConfigurationList = 607FACEF1AFB9204008FA782 /* Build configuration list for PBXNativeTarget "OSSSpeechKit_Example" */; buildPhases = ( - FDA40A8855E8EC8D7B1E4F43 /* [CP] Check Pods Manifest.lock */, 607FACCC1AFB9204008FA782 /* Sources */, 607FACCD1AFB9204008FA782 /* Frameworks */, 607FACCE1AFB9204008FA782 /* Resources */, - 5004C6A87EB6F934EFA310F2 /* [CP] Embed Pods Frameworks */, B042F2D2245FCDD900958719 /* Run Script */, ); buildRules = ( @@ -193,6 +188,9 @@ dependencies = ( ); name = OSSSpeechKit_Example; + packageProductDependencies = ( + B74DEBAB3004E0BA00D7FB43 /* OSSSpeechKit */, + ); productName = OSSSpeechKit; productReference = 607FACD01AFB9204008FA782 /* OSSSpeechKit_Example.app */; productType = "com.apple.product-type.application"; @@ -201,7 +199,6 @@ isa = PBXNativeTarget; buildConfigurationList = 607FACF21AFB9204008FA782 /* Build configuration list for PBXNativeTarget "OSSSpeechKit_Tests" */; buildPhases = ( - EBB80964F428049277FF60C0 /* [CP] Check Pods Manifest.lock */, 607FACE11AFB9204008FA782 /* Sources */, 607FACE21AFB9204008FA782 /* Frameworks */, 607FACE31AFB9204008FA782 /* Resources */, @@ -212,6 +209,9 @@ 607FACE71AFB9204008FA782 /* PBXTargetDependency */, ); name = OSSSpeechKit_Tests; + packageProductDependencies = ( + B74DEBA93004E0B100D7FB43 /* OSSSpeechKit */, + ); productName = Tests; productReference = 607FACE51AFB9204008FA782 /* OSSSpeechKit_Tests.xctest */; productType = "com.apple.product-type.bundle.unit-test"; @@ -222,9 +222,10 @@ 607FACC81AFB9204008FA782 /* Project object */ = { isa = PBXProject; attributes = { + BuildIndependentTargetsInParallel = YES; LastSwiftUpdateCheck = 1140; - LastUpgradeCheck = 1420; - ORGANIZATIONNAME = CocoaPods; + LastUpgradeCheck = 2660; + ORGANIZATIONNAME = OSSSpeechKit; TargetAttributes = { 607FACCF1AFB9204008FA782 = { CreatedOnToolsVersion = 6.3.1; @@ -248,6 +249,9 @@ Base, ); mainGroup = 607FACC71AFB9204008FA782; + packageReferences = ( + B74DEBA73004E08300D7FB43 /* XCLocalSwiftPackageReference ".." */, + ); productRefGroup = 607FACD11AFB9204008FA782 /* Products */; projectDirPath = ""; projectRoot = ""; @@ -273,30 +277,13 @@ isa = PBXResourcesBuildPhase; buildActionMask = 2147483647; files = ( + D10000000000000000000008 /* LocalizableTests.strings in Resources */, ); runOnlyForDeploymentPostprocessing = 0; }; /* End PBXResourcesBuildPhase section */ /* Begin PBXShellScriptBuildPhase section */ - 5004C6A87EB6F934EFA310F2 /* [CP] Embed Pods Frameworks */ = { - isa = PBXShellScriptBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - inputPaths = ( - "${PODS_ROOT}/Target Support Files/Pods-OSSSpeechKit_Example/Pods-OSSSpeechKit_Example-frameworks.sh", - "${BUILT_PRODUCTS_DIR}/OSSSpeechKit/OSSSpeechKit.framework", - ); - name = "[CP] Embed Pods Frameworks"; - outputPaths = ( - "${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/OSSSpeechKit.framework", - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-OSSSpeechKit_Example/Pods-OSSSpeechKit_Example-frameworks.sh\"\n"; - showEnvVarsInLog = 0; - }; B042F2D2245FCDD900958719 /* Run Script */ = { isa = PBXShellScriptBuildPhase; alwaysOutOfDate = 1; @@ -314,51 +301,7 @@ ); runOnlyForDeploymentPostprocessing = 0; shellPath = /bin/sh; - shellScript = "export PATH=\"$PATH:/opt/homebrew/bin\"\nif which swiftlint > /dev/null; then\n swiftlint\nelse\n echo \"warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint\"\nfi\n"; - }; - EBB80964F428049277FF60C0 /* [CP] Check Pods Manifest.lock */ = { - isa = PBXShellScriptBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - inputFileListPaths = ( - ); - inputPaths = ( - "${PODS_PODFILE_DIR_PATH}/Podfile.lock", - "${PODS_ROOT}/Manifest.lock", - ); - name = "[CP] Check Pods Manifest.lock"; - outputFileListPaths = ( - ); - outputPaths = ( - "$(DERIVED_FILE_DIR)/Pods-OSSSpeechKit_Tests-checkManifestLockResult.txt", - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n"; - showEnvVarsInLog = 0; - }; - FDA40A8855E8EC8D7B1E4F43 /* [CP] Check Pods Manifest.lock */ = { - isa = PBXShellScriptBuildPhase; - buildActionMask = 2147483647; - files = ( - ); - inputFileListPaths = ( - ); - inputPaths = ( - "${PODS_PODFILE_DIR_PATH}/Podfile.lock", - "${PODS_ROOT}/Manifest.lock", - ); - name = "[CP] Check Pods Manifest.lock"; - outputFileListPaths = ( - ); - outputPaths = ( - "$(DERIVED_FILE_DIR)/Pods-OSSSpeechKit_Example-checkManifestLockResult.txt", - ); - runOnlyForDeploymentPostprocessing = 0; - shellPath = /bin/sh; - shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n"; - showEnvVarsInLog = 0; + shellScript = "export PATH=\"$PATH:/opt/homebrew/bin\"\nif which swiftlint > /dev/null; then\n cd \"${SRCROOT}\" && swiftlint --config \"${SRCROOT}/.swiftlint.yml\"\nelse\n echo \"warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint\"\nfi\n"; }; /* End PBXShellScriptBuildPhase section */ @@ -371,6 +314,9 @@ B04ABC992458500100ACE8F2 /* CountryLanguageTableViewCell.swift in Sources */, B042F2D4245FEDC600958719 /* SFSpeechRecognizerMock.swift in Sources */, 607FACD61AFB9204008FA782 /* AppDelegate.swift in Sources */, + C10000000000000000000001 /* SceneDelegate.swift in Sources */, + D10000000000000000000003 /* RecordingSessionModel.swift in Sources */, + D10000000000000000000001 /* RecordingSessionViewController.swift in Sources */, ); runOnlyForDeploymentPostprocessing = 0; }; @@ -380,6 +326,9 @@ files = ( B042F2D5245FEDC600958719 /* SFSpeechRecognizerMock.swift in Sources */, B06260E122ABCA2600069801 /* OSSSpeechTests.swift in Sources */, + A10000000000000000000001 /* ModernOSSSpeechTests.swift in Sources */, + D10000000000000000000005 /* RecordingSessionModel.swift in Sources */, + D10000000000000000000006 /* RecordingSessionModelTests.swift in Sources */, ); runOnlyForDeploymentPostprocessing = 0; }; @@ -436,7 +385,7 @@ CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer"; COPY_PHASE_STRIP = NO; - DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + DEBUG_INFORMATION_FORMAT = dwarf; ENABLE_STRICT_OBJC_MSGSEND = YES; ENABLE_TESTABILITY = YES; GCC_C_LANGUAGE_STANDARD = gnu99; @@ -454,10 +403,11 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 13.0; + IPHONEOS_DEPLOYMENT_TARGET = 17.0; MTL_ENABLE_DEBUG_INFO = YES; ONLY_ACTIVE_ARCH = YES; SDKROOT = iphoneos; + STRING_CATALOG_GENERATE_SYMBOLS = YES; SWIFT_OPTIMIZATION_LEVEL = "-Onone"; }; name = Debug; @@ -505,9 +455,11 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 13.0; + IPHONEOS_DEPLOYMENT_TARGET = 17.0; MTL_ENABLE_DEBUG_INFO = NO; SDKROOT = iphoneos; + STRING_CATALOG_GENERATE_SYMBOLS = YES; + SWIFT_COMPILATION_MODE = wholemodule; SWIFT_OPTIMIZATION_LEVEL = "-Onone"; VALIDATE_PRODUCT = YES; }; @@ -515,21 +467,20 @@ }; 607FACF01AFB9204008FA782 /* Debug */ = { isa = XCBuildConfiguration; - baseConfigurationReference = D9904FC64C70B4667E482942 /* Pods-OSSSpeechKit_Example.debug.xcconfig */; buildSettings = { ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; CODE_SIGN_IDENTITY = "iPhone Developer"; CODE_SIGN_STYLE = Automatic; - DEVELOPMENT_TEAM = ""; + DEVELOPMENT_TEAM = 4632R9FHL5; GCC_OPTIMIZATION_LEVEL = 0; INFOPLIST_FILE = OSSSpeechKit/Info.plist; - IPHONEOS_DEPLOYMENT_TARGET = 13.0; + IPHONEOS_DEPLOYMENT_TARGET = 17.0; LD_RUNPATH_SEARCH_PATHS = ( "$(inherited)", "@executable_path/Frameworks", ); MODULE_NAME = ExampleApp; - PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.demo.$(PRODUCT_NAME:rfc1034identifier)"; + PRODUCT_BUNDLE_IDENTIFIER = "com.appdevguy.$(PRODUCT_NAME:rfc1034identifier)"; PRODUCT_NAME = "$(TARGET_NAME)"; PROVISIONING_PROFILE_SPECIFIER = ""; SWIFT_OPTIMIZATION_LEVEL = "-Onone"; @@ -539,21 +490,20 @@ }; 607FACF11AFB9204008FA782 /* Release */ = { isa = XCBuildConfiguration; - baseConfigurationReference = 969F0DB7618212626605C72B /* Pods-OSSSpeechKit_Example.release.xcconfig */; buildSettings = { ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon; CODE_SIGN_IDENTITY = "iPhone Developer"; CODE_SIGN_STYLE = Automatic; - DEVELOPMENT_TEAM = ""; + DEVELOPMENT_TEAM = 4632R9FHL5; GCC_OPTIMIZATION_LEVEL = 0; INFOPLIST_FILE = OSSSpeechKit/Info.plist; - IPHONEOS_DEPLOYMENT_TARGET = 13.0; + IPHONEOS_DEPLOYMENT_TARGET = 17.0; LD_RUNPATH_SEARCH_PATHS = ( "$(inherited)", "@executable_path/Frameworks", ); MODULE_NAME = ExampleApp; - PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.demo.$(PRODUCT_NAME:rfc1034identifier)"; + PRODUCT_BUNDLE_IDENTIFIER = "com.appdevguy.$(PRODUCT_NAME:rfc1034identifier)"; PRODUCT_NAME = "$(TARGET_NAME)"; PROVISIONING_PROFILE_SPECIFIER = ""; SWIFT_OPTIMIZATION_LEVEL = "-Onone"; @@ -563,11 +513,10 @@ }; 607FACF31AFB9204008FA782 /* Debug */ = { isa = XCBuildConfiguration; - baseConfigurationReference = 8E50A387E6C9227B46CD07D5 /* Pods-OSSSpeechKit_Tests.debug.xcconfig */; buildSettings = { CODE_SIGN_IDENTITY = "iPhone Developer"; CODE_SIGN_STYLE = Automatic; - DEVELOPMENT_TEAM = ""; + DEVELOPMENT_TEAM = 4632R9FHL5; FRAMEWORK_SEARCH_PATHS = ( "$(SDKROOT)/Developer/Library/Frameworks", "$(inherited)", @@ -578,13 +527,13 @@ "$(inherited)", ); INFOPLIST_FILE = Tests/Info.plist; - IPHONEOS_DEPLOYMENT_TARGET = 13.0; + IPHONEOS_DEPLOYMENT_TARGET = 17.0; LD_RUNPATH_SEARCH_PATHS = ( "$(inherited)", "@executable_path/Frameworks", "@loader_path/Frameworks", ); - PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.$(PRODUCT_NAME:rfc1034identifier)"; + PRODUCT_BUNDLE_IDENTIFIER = "com.appdevguy.$(PRODUCT_NAME:rfc1034identifier)"; PRODUCT_NAME = "$(TARGET_NAME)"; PROVISIONING_PROFILE_SPECIFIER = ""; SWIFT_OPTIMIZATION_LEVEL = "-Onone"; @@ -595,24 +544,23 @@ }; 607FACF41AFB9204008FA782 /* Release */ = { isa = XCBuildConfiguration; - baseConfigurationReference = EB2636A7260A79C428DB0FCF /* Pods-OSSSpeechKit_Tests.release.xcconfig */; buildSettings = { CODE_SIGN_IDENTITY = "iPhone Developer"; CODE_SIGN_STYLE = Automatic; - DEVELOPMENT_TEAM = ""; + DEVELOPMENT_TEAM = 4632R9FHL5; FRAMEWORK_SEARCH_PATHS = ( "$(SDKROOT)/Developer/Library/Frameworks", "$(inherited)", ); GCC_OPTIMIZATION_LEVEL = 0; INFOPLIST_FILE = Tests/Info.plist; - IPHONEOS_DEPLOYMENT_TARGET = 13.0; + IPHONEOS_DEPLOYMENT_TARGET = 17.0; LD_RUNPATH_SEARCH_PATHS = ( "$(inherited)", "@executable_path/Frameworks", "@loader_path/Frameworks", ); - PRODUCT_BUNDLE_IDENTIFIER = "org.cocoapods.$(PRODUCT_NAME:rfc1034identifier)"; + PRODUCT_BUNDLE_IDENTIFIER = "com.appdevguy.$(PRODUCT_NAME:rfc1034identifier)"; PRODUCT_NAME = "$(TARGET_NAME)"; PROVISIONING_PROFILE_SPECIFIER = ""; SWIFT_OPTIMIZATION_LEVEL = "-Onone"; @@ -652,6 +600,26 @@ defaultConfigurationName = Release; }; /* End XCConfigurationList section */ + +/* Begin XCLocalSwiftPackageReference section */ + B74DEBA73004E08300D7FB43 /* XCLocalSwiftPackageReference ".." */ = { + isa = XCLocalSwiftPackageReference; + relativePath = ..; + }; +/* End XCLocalSwiftPackageReference section */ + +/* Begin XCSwiftPackageProductDependency section */ + B74DEBA93004E0B100D7FB43 /* OSSSpeechKit */ = { + isa = XCSwiftPackageProductDependency; + package = B74DEBA73004E08300D7FB43 /* XCLocalSwiftPackageReference ".." */; + productName = OSSSpeechKit; + }; + B74DEBAB3004E0BA00D7FB43 /* OSSSpeechKit */ = { + isa = XCSwiftPackageProductDependency; + package = B74DEBA73004E08300D7FB43 /* XCLocalSwiftPackageReference ".." */; + productName = OSSSpeechKit; + }; +/* End XCSwiftPackageProductDependency section */ }; rootObject = 607FACC81AFB9204008FA782 /* Project object */; } diff --git a/Example/OSSSpeechKit.xcodeproj/xcshareddata/xcschemes/OSSSpeechKit-Example.xcscheme b/Example/OSSSpeechKit.xcodeproj/xcshareddata/xcschemes/OSSSpeechKit-Example.xcscheme index 99dd2fd..c420daa 100644 --- a/Example/OSSSpeechKit.xcodeproj/xcshareddata/xcschemes/OSSSpeechKit-Example.xcscheme +++ b/Example/OSSSpeechKit.xcodeproj/xcshareddata/xcschemes/OSSSpeechKit-Example.xcscheme @@ -1,44 +1,10 @@ + LastUpgradeVersion = "2660" + version = "1.3"> - - - - - - - - - - - - - - - - - - - - - - + codeCoverageEnabled = "YES"> diff --git a/Example/OSSSpeechKit.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/Example/OSSSpeechKit.xcodeproj/xcuserdata/supermac.xcuserdatad/xcschemes/xcschememanagement.plist similarity index 52% rename from Example/OSSSpeechKit.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist rename to Example/OSSSpeechKit.xcodeproj/xcuserdata/supermac.xcuserdatad/xcschemes/xcschememanagement.plist index 18d9810..247183c 100644 --- a/Example/OSSSpeechKit.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist +++ b/Example/OSSSpeechKit.xcodeproj/xcuserdata/supermac.xcuserdatad/xcschemes/xcschememanagement.plist @@ -2,7 +2,13 @@ - IDEDidComputeMac32BitWarning - + SchemeUserState + + OSSSpeechKit-Example.xcscheme_^#shared#^_ + + orderHint + 0 + + diff --git a/Example/OSSSpeechKit.xcworkspace/contents.xcworkspacedata b/Example/OSSSpeechKit.xcworkspace/contents.xcworkspacedata deleted file mode 100644 index 412aaab..0000000 --- a/Example/OSSSpeechKit.xcworkspace/contents.xcworkspacedata +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - diff --git a/Example/OSSSpeechKit.xcworkspace/xcuserdata/seansmith.xcuserdatad/IDEFindNavigatorScopes.plist b/Example/OSSSpeechKit.xcworkspace/xcuserdata/seansmith.xcuserdatad/IDEFindNavigatorScopes.plist deleted file mode 100644 index 5dd5da8..0000000 --- a/Example/OSSSpeechKit.xcworkspace/xcuserdata/seansmith.xcuserdatad/IDEFindNavigatorScopes.plist +++ /dev/null @@ -1,5 +0,0 @@ - - - - - diff --git a/Example/OSSSpeechKit/AppDelegate.swift b/Example/OSSSpeechKit/AppDelegate.swift index d7c649e..d4eb21d 100644 --- a/Example/OSSSpeechKit/AppDelegate.swift +++ b/Example/OSSSpeechKit/AppDelegate.swift @@ -1,38 +1,15 @@ -// Copyright © 2018-2020 App Dev Guy. All rights reserved. -// -// This code is distributed under the terms and conditions of the MIT license. -// -// Permission is hereby granted, free of charge, to any person obtaining a copy -// of this software and associated documentation files (the "Software"), to -// deal in the Software without restriction, including without limitation the -// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or -// sell copies of the Software, and to permit persons to whom the Software is -// furnished to do so, subject to the following conditions: -// -// The above copyright notice and this permission notice shall be included in -// all copies or substantial portions of the Software. -// -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS -// IN THE SOFTWARE. -// - import UIKit -@UIApplicationMain +@main class AppDelegate: UIResponder, UIApplicationDelegate { - - var window: UIWindow? - - func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { - self.window = UIWindow(frame: UIScreen.main.bounds) - let navigationController = UINavigationController(rootViewController: CountryLanguageListTableViewController()) - self.window?.rootViewController = navigationController - self.window?.makeKeyAndVisible() - return true + func application( + _ application: UIApplication, + configurationForConnecting connectingSceneSession: UISceneSession, + options: UIScene.ConnectionOptions + ) -> UISceneConfiguration { + UISceneConfiguration( + name: "Default Configuration", + sessionRole: connectingSceneSession.role + ) } } diff --git a/Example/OSSSpeechKit/CountryLanguageListTableViewController.swift b/Example/OSSSpeechKit/CountryLanguageListTableViewController.swift index a318c06..a34fdcd 100644 --- a/Example/OSSSpeechKit/CountryLanguageListTableViewController.swift +++ b/Example/OSSSpeechKit/CountryLanguageListTableViewController.swift @@ -28,7 +28,7 @@ class CountryLanguageListTableViewController: UITableViewController { // MARK: - Variables - private let speechKit = OSSSpeech.shared + private let speechKit = OSSSpeechEngine() private lazy var microphoneButton: UIBarButtonItem = { var micImage: UIImage? @@ -45,7 +45,6 @@ class CountryLanguageListTableViewController: UITableViewController { super.viewDidLoad() title = "Languages" tableView.accessibilityIdentifier = "OSSSpeechKitLanguageTableView" - speechKit.delegate = self navigationItem.rightBarButtonItem = microphoneButton tableView.register(CountryLanguageTableViewCell.self, forCellReuseIdentifier: CountryLanguageTableViewCell.reuseIdentifier) @@ -54,23 +53,20 @@ class CountryLanguageListTableViewController: UITableViewController { // MARK: - Voice Recording @objc func recordVoice() { - shoudlStartRecordingVoice(microphoneButton.tintColor != .red) - } - - private func shoudlStartRecordingVoice(_ shouldRecord: Bool) { - updateMicButtonColor(forState: shouldRecord) - if !shouldRecord { - speechKit.endVoiceRecording() - return - } - speechKit.recordVoice() - } - - func updateMicButtonColor(forState isRecording: Bool) { - DispatchQueue.main.async { [weak self] in - guard let self else { return } - self.microphoneButton.tintColor = isRecording ? .red : .label + let selectedLanguage = tableView.indexPathForSelectedRow + .map { OSSLanguage.catalog[$0.row] } + ?? OSSLanguage.catalog.first(where: { $0.id == "english-us" })! + let recordingController = RecordingSessionViewController( + model: RecordingSessionModel(language: selectedLanguage) + ) + recordingController.modalPresentationStyle = .pageSheet + if let sheet = recordingController.sheetPresentationController { + sheet.detents = [.medium(), .large()] + sheet.selectedDetentIdentifier = .large + sheet.prefersGrabberVisible = true + sheet.prefersScrollingExpandsWhenScrolledToEdge = false } + present(recordingController, animated: true) } } @@ -83,7 +79,7 @@ extension CountryLanguageListTableViewController { } override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int { - return OSSVoiceEnum.allCases.count + return OSSLanguage.catalog.count } override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell { @@ -91,55 +87,43 @@ extension CountryLanguageListTableViewController { for: indexPath) as? CountryLanguageTableViewCell else { return UITableViewCell(style: .subtitle, reuseIdentifier: UITableViewCell.reuseIdentifier) } - cell.language = OSSVoiceEnum.allCases[indexPath.row] + cell.language = OSSLanguage.catalog[indexPath.row] cell.isAccessibilityElement = true cell.accessibilityIdentifier = "OSSLanguageCell_\(indexPath.section)_\(indexPath.row)" return cell } override func tableView(_ tableView: UITableView, didSelectRowAt indexPath: IndexPath) { - // NOTE: Must set the voice before requesting speech. This can be set once. - speechKit.voice = OSSVoice(quality: .enhanced, language: OSSVoiceEnum.allCases[indexPath.item]) - speechKit.utterance?.rate = 0.45 - // Test attributed string vs normal string - if indexPath.item % 2 == 0 { - speechKit.speakText(OSSVoiceEnum.allCases[indexPath.item].demoMessage) - } else { - let attributedString = NSAttributedString(string: OSSVoiceEnum.allCases[indexPath.item].demoMessage) - speechKit.speakAttributedText(attributedText: attributedString) + let language = OSSLanguage.catalog[indexPath.row] + Task { + do { + try await speak("Hello from \(language.name)", language: language) + } catch { + presentError(error) + } } } -} -extension CountryLanguageListTableViewController: OSSSpeechDelegate { - - func didCompleteTranslation(withText text: String) { - print("Translation completed: \(text)") - } - - func didFailToProcessRequest(withError error: Error?) { - shoudlStartRecordingVoice(false) - guard let err = error else { - print("Error with the request but the error returned is nil") - return - } - print("Error with the request: \(err)") - } - - func authorizationToMicrophone(withAuthentication type: OSSSpeechKitAuthorizationStatus) { - print("Authorization status has returned: \(type.message).") + private func speak(_ text: String, language: OSSLanguage) async throws { + try await speechKit.speak( + text, + voice: OSSVoiceConfiguration(language: language), + configuration: .init(rate: 0.45) + ) } - - func didFailToCommenceSpeechRecording() { - print("Failed to record speech.") - shoudlStartRecordingVoice(false) - } - - func didFinishListening(withText text: String) { - OperationQueue.main.addOperation { [weak self] in - self?.updateMicButtonColor(forState: false) - self?.speechKit.speakText(text) + + private func presentError(_ error: Error) { + var message = error.localizedDescription + if case OSSSpeechError.voiceUnavailable = error { + message += "\n\nOn the simulator, open Settings > Accessibility > Spoken Content > Voices and download a voice for the selected language." } + let alert = UIAlertController( + title: "Speech unavailable", + message: message, + preferredStyle: .alert + ) + alert.addAction(UIAlertAction(title: "OK", style: .default)) + present(alert, animated: true) } } diff --git a/Example/OSSSpeechKit/CountryLanguageTableViewCell.swift b/Example/OSSSpeechKit/CountryLanguageTableViewCell.swift index 50e0bf3..d11e34b 100644 --- a/Example/OSSSpeechKit/CountryLanguageTableViewCell.swift +++ b/Example/OSSSpeechKit/CountryLanguageTableViewCell.swift @@ -28,11 +28,14 @@ class CountryLanguageTableViewCell: UITableViewCell { // MARK: - Variables - public var language: OSSVoiceEnum? { + public var language: OSSLanguage? { didSet { - imageView?.image = language?.flag - textLabel?.text = language?.title - detailTextLabel?.text = language?.rawValue + imageView?.image = language?.renderedFlagImage() + textLabel?.text = language?.name + detailTextLabel?.text = language?.localeIdentifier + accessibilityLabel = [language?.name, language?.localeIdentifier] + .compactMap { $0 } + .joined(separator: ", ") } } @@ -49,10 +52,6 @@ class CountryLanguageTableViewCell: UITableViewCell { fatalError("init(coder:) has not been implemented") } - override func awakeFromNib() { - super.awakeFromNib() - } - override func prepareForReuse() { super.prepareForReuse() textLabel?.text = "" diff --git a/Example/OSSSpeechKit/Info.plist b/Example/OSSSpeechKit/Info.plist index 2898afc..1c10efa 100644 --- a/Example/OSSSpeechKit/Info.plist +++ b/Example/OSSSpeechKit/Info.plist @@ -24,6 +24,23 @@ 1 LSRequiresIPhoneOS + UIApplicationSceneManifest + + UIApplicationSupportsMultipleScenes + + UISceneConfigurations + + UIWindowSceneSessionRoleApplication + + + UISceneConfigurationName + Default Configuration + UISceneDelegateClassName + $(PRODUCT_MODULE_NAME).SceneDelegate + + + + NSMicrophoneUsageDescription To use commands, we need to access the microphone. NSSpeechRecognitionUsageDescription diff --git a/Example/OSSSpeechKit/RecordingSessionModel.swift b/Example/OSSSpeechKit/RecordingSessionModel.swift new file mode 100644 index 0000000..5f58877 --- /dev/null +++ b/Example/OSSSpeechKit/RecordingSessionModel.swift @@ -0,0 +1,360 @@ +import Foundation +import OSSSpeechKit + +@MainActor +protocol SpeechRecognitionSessionProviding: AnyObject { + func continuousRecognitionEvents( + locale: Locale, + requestAuthorization: Bool + ) async throws -> AsyncThrowingStream + func pauseRecognition() + func resumeRecognition() throws + func finishRecognition() + func cancelRecognition() +} + +extension OSSSpeechEngine: SpeechRecognitionSessionProviding {} + +@MainActor +final class RecordingSessionModel { + private static let rowBreakThreshold: TimeInterval = 0.8 + + private struct TranscriptChunk { + let row: TranscriptRow + let segmentCount: Int + } + + struct TranscriptRow: Equatable { + let timestamp: TimeInterval + let text: String + } + + enum Status: Equatable { + case idle + case recording + case paused + case stopped + } + + let language: OSSLanguage + private(set) var status: Status = .idle + private(set) var rows: [TranscriptRow] = [] + private(set) var liveText = "" + private(set) var liveTimestamp: TimeInterval? + + var onChange: (() -> Void)? + var onError: ((Error) -> Void)? + var onStop: (() -> Void)? + + var elapsedTime: TimeInterval { + accumulatedActiveTime + (activeStartedAt.map { now().timeIntervalSince($0) } ?? 0) + } + + private let engine: SpeechRecognitionSessionProviding + private let now: () -> Date + private var recognitionTask: Task? + private var timer: Timer? + private var silenceTimer: Timer? + private var activeStartedAt: Date? + private var accumulatedActiveTime: TimeInterval = 0 + private var consumedSegmentCount = 0 + private var latestSegmentCount = 0 + private var lastTranscriptSignature = "" + private var didStop = false + + convenience init(language: OSSLanguage) { + self.init(language: language, engine: OSSSpeechEngine()) + } + + init( + language: OSSLanguage, + engine: SpeechRecognitionSessionProviding, + now: @escaping () -> Date = Date.init + ) { + self.language = language + self.engine = engine + self.now = now + } + + deinit { + recognitionTask?.cancel() + timer?.invalidate() + silenceTimer?.invalidate() + } + + func start() { + guard status == .idle else { return } + recognitionTask = Task { [weak self] in + guard let self else { return } + do { + let events = try await engine.continuousRecognitionEvents( + locale: language.locale, + requestAuthorization: true + ) + guard !Task.isCancelled else { return } + status = .recording + activeStartedAt = now() + startTimer() + notifyChange() + + for try await event in events { + guard !Task.isCancelled else { return } + handle(event) + } + } catch is CancellationError { + return + } catch { + fail(with: error) + } + } + } + + func pause() { + guard status == .recording else { return } + finalizeLiveText() + resetTranscriptTracking() + accumulatedActiveTime = elapsedTime + activeStartedAt = nil + engine.pauseRecognition() + status = .paused + notifyChange() + } + + func resume() { + guard status == .paused else { return } + do { + try engine.resumeRecognition() + liveText = "" + liveTimestamp = nil + activeStartedAt = now() + status = .recording + notifyChange() + } catch { + fail(with: error) + } + } + + func stop() { + guard !didStop else { return } + didStop = true + if status == .recording { + accumulatedActiveTime = elapsedTime + activeStartedAt = nil + } + finalizeLiveText() + resetTranscriptTracking() + timer?.invalidate() + timer = nil + engine.finishRecognition() + recognitionTask?.cancel() + status = .stopped + notifyChange() + onStop?() + } + + func cancel() { + guard !didStop else { return } + didStop = true + timer?.invalidate() + timer = nil + resetTranscriptTracking() + recognitionTask?.cancel() + engine.cancelRecognition() + status = .stopped + notifyChange() + } + + func refreshElapsedTime() { + notifyChange() + } + + func formattedTimestamp(_ interval: TimeInterval) -> String { + let totalSeconds = max(0, Int(interval)) + let hours = totalSeconds / 3_600 + let minutes = (totalSeconds % 3_600) / 60 + let seconds = totalSeconds % 60 + if hours > 0 { + return String(format: "%d:%02d:%02d", hours, minutes, seconds) + } + return String(format: "%02d:%02d", minutes, seconds) + } + + private func handle(_ event: OSSSpeechContinuousRecognitionEvent) { + switch event { + case .transcript(let transcript): + apply(transcript) + case .availabilityChanged(let available): + if !available { + fail(with: OSSSpeechError.recognizerUnavailable) + } + case .paused: + break + case .resumed: + break + case .completed: + completeFromEngine() + case .cancelled: + cancel() + } + } + + private func apply(_ transcript: OSSSpeechTranscript) { + if transcript.segments.count < consumedSegmentCount { + resetTranscriptTracking() + } + + let remainingSegments = Array(transcript.segments.dropFirst(consumedSegmentCount)) + let chunks = transcriptChunks( + from: remainingSegments, + fallbackText: transcript.formattedText + ) + let completedCount = transcript.isFinal ? chunks.count : max(0, chunks.count - 1) + for chunk in chunks.prefix(completedCount) { + rows.append(.init( + timestamp: liveTimestamp ?? chunk.row.timestamp, + text: chunk.row.text + )) + consumedSegmentCount += chunk.segmentCount + liveText = "" + liveTimestamp = nil + } + + if transcript.isFinal { + liveText = "" + liveTimestamp = nil + resetTranscriptTracking() + } else if let liveChunk = chunks.last { + if liveText.isEmpty { + liveTimestamp = elapsedTime + } + liveText = liveChunk.row.text + latestSegmentCount = transcript.segments.count + scheduleSilenceBreakIfNeeded(for: transcript) + } + notifyChange() + } + + private func finalizeLiveText() { + let text = liveText.trimmingCharacters(in: .whitespacesAndNewlines) + guard !text.isEmpty else { + liveText = "" + liveTimestamp = nil + return + } + rows.append(.init(timestamp: liveTimestamp ?? elapsedTime, text: text)) + liveText = "" + liveTimestamp = nil + } + + private func transcriptChunks( + from segments: [OSSSpeechTranscriptSegment], + fallbackText: String + ) -> [TranscriptChunk] { + guard !segments.isEmpty else { + let text = fallbackText.trimmingCharacters(in: .whitespacesAndNewlines) + return text.isEmpty ? [] : [ + .init(row: .init(timestamp: elapsedTime, text: text), segmentCount: 0) + ] + } + + var chunks: [TranscriptChunk] = [] + var chunkSegments: [OSSSpeechTranscriptSegment] = [] + + for segment in segments { + if let previous = chunkSegments.last { + let gap = segment.timestamp - (previous.timestamp + previous.duration) + if gap >= Self.rowBreakThreshold { + chunks.append(makeChunk(from: chunkSegments)) + chunkSegments.removeAll(keepingCapacity: true) + } + } + chunkSegments.append(segment) + } + + if !chunkSegments.isEmpty { + chunks.append(makeChunk(from: chunkSegments)) + } + return chunks + } + + private func makeChunk(from segments: [OSSSpeechTranscriptSegment]) -> TranscriptChunk { + var text = segments.map(\.text).joined(separator: " ") + for punctuation in [".", ",", "!", "?", ";", ":"] { + text = text.replacingOccurrences(of: " \(punctuation)", with: punctuation) + } + return .init( + row: .init( + timestamp: segments.first?.timestamp ?? elapsedTime, + text: text.trimmingCharacters(in: .whitespacesAndNewlines) + ), + segmentCount: segments.count + ) + } + + private func scheduleSilenceBreakIfNeeded(for transcript: OSSSpeechTranscript) { + let signature = transcript.segments + .map { "\($0.timestamp):\($0.duration):\($0.text)" } + .joined(separator: "|") + guard signature != lastTranscriptSignature else { return } + lastTranscriptSignature = signature + silenceTimer?.invalidate() + let timer = Timer(timeInterval: Self.rowBreakThreshold, repeats: false) { [weak self] _ in + Task { @MainActor in self?.handleSilenceBreak() } + } + RunLoop.main.add(timer, forMode: .common) + silenceTimer = timer + } + + private func handleSilenceBreak() { + guard status == .recording, !liveText.isEmpty else { return } + finalizeLiveText() + consumedSegmentCount = latestSegmentCount + silenceTimer = nil + notifyChange() + } + + private func resetTranscriptTracking() { + silenceTimer?.invalidate() + silenceTimer = nil + consumedSegmentCount = 0 + latestSegmentCount = 0 + lastTranscriptSignature = "" + } + + private func completeFromEngine() { + guard !didStop else { return } + didStop = true + finalizeLiveText() + timer?.invalidate() + timer = nil + resetTranscriptTracking() + status = .stopped + notifyChange() + onStop?() + } + + private func fail(with error: Error) { + guard !didStop else { return } + didStop = true + timer?.invalidate() + timer = nil + resetTranscriptTracking() + status = .stopped + engine.cancelRecognition() + notifyChange() + onError?(error) + } + + private func startTimer() { + timer?.invalidate() + let timer = Timer(timeInterval: 0.1, repeats: true) { [weak self] _ in + Task { @MainActor in self?.refreshElapsedTime() } + } + RunLoop.main.add(timer, forMode: .common) + self.timer = timer + } + + private func notifyChange() { + onChange?() + } +} diff --git a/Example/OSSSpeechKit/RecordingSessionViewController.swift b/Example/OSSSpeechKit/RecordingSessionViewController.swift new file mode 100644 index 0000000..40c41cc --- /dev/null +++ b/Example/OSSSpeechKit/RecordingSessionViewController.swift @@ -0,0 +1,280 @@ +import UIKit + +final class RecordingSessionViewController: UIViewController { + private let model: RecordingSessionModel + private var isDismissalInProgress = false + + private let timerLabel: UILabel = { + let label = UILabel() + label.font = .monospacedDigitSystemFont(ofSize: 42, weight: .medium) + label.textAlignment = .center + label.accessibilityIdentifier = "RecordingSessionTimer" + return label + }() + + private let statusLabel: UILabel = { + let label = UILabel() + label.font = .preferredFont(forTextStyle: .subheadline) + label.textColor = .secondaryLabel + label.textAlignment = .center + return label + }() + + private let tableView: UITableView = { + let tableView = UITableView(frame: .zero, style: .plain) + tableView.separatorStyle = .none + tableView.keyboardDismissMode = .interactive + tableView.accessibilityIdentifier = "RecordingSessionTranscript" + return tableView + }() + + private lazy var pauseButton: UIButton = { + var configuration = UIButton.Configuration.filled() + configuration.cornerStyle = .capsule + configuration.imagePadding = 8 + let button = UIButton(configuration: configuration) + button.addTarget(self, action: #selector(togglePause), for: .touchUpInside) + button.accessibilityIdentifier = "RecordingSessionPauseButton" + return button + }() + + private lazy var stopButton: UIButton = { + var configuration = UIButton.Configuration.filled() + configuration.cornerStyle = .capsule + configuration.baseBackgroundColor = .systemRed + configuration.baseForegroundColor = .white + configuration.image = UIImage(systemName: "stop.fill") + configuration.imagePadding = 8 + configuration.title = "Stop" + let button = UIButton(configuration: configuration) + button.addTarget(self, action: #selector(stopRecording), for: .touchUpInside) + button.accessibilityIdentifier = "RecordingSessionStopButton" + return button + }() + + init(model: RecordingSessionModel) { + self.model = model + super.init(nibName: nil, bundle: nil) + } + + @available(*, unavailable) + required init?(coder: NSCoder) { + fatalError("init(coder:) has not been implemented") + } + + override func viewDidLoad() { + super.viewDidLoad() + title = model.language.name + view.backgroundColor = .systemBackground + tableView.dataSource = self + tableView.register( + TranscriptTableViewCell.self, + forCellReuseIdentifier: TranscriptTableViewCell.reuseIdentifier + ) + configureLayout() + bindModel() + render() + } + + override func viewDidAppear(_ animated: Bool) { + super.viewDidAppear(animated) + presentationController?.delegate = self + model.start() + } + + private func configureLayout() { + let headingLabel = UILabel() + headingLabel.text = "\(model.language.name) Transcription" + headingLabel.font = .preferredFont(forTextStyle: .title2) + headingLabel.textAlignment = .center + + let controls = UIStackView(arrangedSubviews: [pauseButton, stopButton]) + controls.axis = .horizontal + controls.spacing = 16 + controls.distribution = .fillEqually + + let header = UIStackView(arrangedSubviews: [headingLabel, timerLabel, statusLabel]) + header.axis = .vertical + header.spacing = 6 + + [header, tableView, controls].forEach { + $0.translatesAutoresizingMaskIntoConstraints = false + view.addSubview($0) + } + + let guide = view.safeAreaLayoutGuide + NSLayoutConstraint.activate([ + header.topAnchor.constraint(equalTo: guide.topAnchor, constant: 24), + header.leadingAnchor.constraint(equalTo: guide.leadingAnchor, constant: 20), + header.trailingAnchor.constraint(equalTo: guide.trailingAnchor, constant: -20), + + tableView.topAnchor.constraint(equalTo: header.bottomAnchor, constant: 16), + tableView.leadingAnchor.constraint(equalTo: view.leadingAnchor), + tableView.trailingAnchor.constraint(equalTo: view.trailingAnchor), + + controls.topAnchor.constraint(equalTo: tableView.bottomAnchor, constant: 12), + controls.leadingAnchor.constraint(equalTo: guide.leadingAnchor, constant: 20), + controls.trailingAnchor.constraint(equalTo: guide.trailingAnchor, constant: -20), + controls.bottomAnchor.constraint(equalTo: guide.bottomAnchor, constant: -16), + controls.heightAnchor.constraint(equalToConstant: 54) + ]) + } + + private func bindModel() { + model.onChange = { [weak self] in + self?.render() + } + model.onError = { [weak self] error in + self?.presentError(error) + } + } + + private func render() { + timerLabel.text = model.formattedTimestamp(model.elapsedTime) + switch model.status { + case .idle: + statusLabel.text = "Starting…" + pauseButton.isEnabled = false + setPauseButton(title: "Pause", image: "pause.fill") + case .recording: + statusLabel.text = "Recording" + pauseButton.isEnabled = true + setPauseButton(title: "Pause", image: "pause.fill") + case .paused: + statusLabel.text = "Paused" + pauseButton.isEnabled = true + setPauseButton(title: "Resume", image: "mic.fill") + case .stopped: + statusLabel.text = "Stopped" + pauseButton.isEnabled = false + stopButton.isEnabled = false + } + + tableView.reloadData() + let count = tableView.numberOfRows(inSection: 0) + if !model.rows.isEmpty || !model.liveText.isEmpty { + tableView.scrollToRow( + at: IndexPath(row: count - 1, section: 0), + at: .bottom, + animated: false + ) + } + } + + private func setPauseButton(title: String, image: String) { + pauseButton.configuration?.title = title + pauseButton.configuration?.image = UIImage(systemName: image) + pauseButton.accessibilityLabel = title + } + + @objc private func togglePause() { + switch model.status { + case .recording: + model.pause() + case .paused: + model.resume() + case .idle, .stopped: + break + } + } + + @objc private func stopRecording() { + model.stop() + } + + private func presentError(_ error: Error) { + let alert = UIAlertController( + title: "Transcription unavailable", + message: error.localizedDescription, + preferredStyle: .alert + ) + alert.addAction(UIAlertAction(title: "Close", style: .default) { [weak self] _ in + guard let self else { return } + isDismissalInProgress = true + dismiss(animated: true) + }) + present(alert, animated: true) + } +} + +extension RecordingSessionViewController: UITableViewDataSource { + func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int { + model.rows.count + (model.liveText.isEmpty ? 0 : 1) + } + + func tableView( + _ tableView: UITableView, + cellForRowAt indexPath: IndexPath + ) -> UITableViewCell { + guard let cell = tableView.dequeueReusableCell( + withIdentifier: TranscriptTableViewCell.reuseIdentifier, + for: indexPath + ) as? TranscriptTableViewCell else { + return UITableViewCell() + } + + if indexPath.row < model.rows.count { + let row = model.rows[indexPath.row] + cell.configure( + timestamp: model.formattedTimestamp(row.timestamp), + text: row.text, + isLive: false + ) + } else { + cell.configure( + timestamp: model.formattedTimestamp(model.liveTimestamp ?? model.elapsedTime), + text: model.liveText, + isLive: true + ) + } + return cell + } +} + +extension RecordingSessionViewController: UIAdaptivePresentationControllerDelegate { + func presentationControllerWillDismiss(_ presentationController: UIPresentationController) { + isDismissalInProgress = true + model.stop() + } +} + +private final class TranscriptTableViewCell: UITableViewCell { + private let timestampLabel = UILabel() + private let transcriptLabel = UILabel() + + override init(style: UITableViewCell.CellStyle, reuseIdentifier: String?) { + super.init(style: style, reuseIdentifier: reuseIdentifier) + selectionStyle = .none + timestampLabel.font = .monospacedDigitSystemFont(ofSize: 13, weight: .medium) + timestampLabel.textColor = .secondaryLabel + transcriptLabel.font = .preferredFont(forTextStyle: .body) + transcriptLabel.numberOfLines = 0 + + let stack = UIStackView(arrangedSubviews: [timestampLabel, transcriptLabel]) + stack.axis = .horizontal + stack.alignment = .firstBaseline + stack.spacing = 12 + stack.translatesAutoresizingMaskIntoConstraints = false + contentView.addSubview(stack) + + NSLayoutConstraint.activate([ + stack.topAnchor.constraint(equalTo: contentView.topAnchor, constant: 10), + stack.leadingAnchor.constraint(equalTo: contentView.leadingAnchor, constant: 20), + stack.trailingAnchor.constraint(equalTo: contentView.trailingAnchor, constant: -20), + stack.bottomAnchor.constraint(equalTo: contentView.bottomAnchor, constant: -10), + timestampLabel.widthAnchor.constraint(greaterThanOrEqualToConstant: 44) + ]) + } + + @available(*, unavailable) + required init?(coder: NSCoder) { + fatalError("init(coder:) has not been implemented") + } + + func configure(timestamp: String, text: String, isLive: Bool) { + timestampLabel.text = timestamp + transcriptLabel.text = text + transcriptLabel.textColor = isLive ? .secondaryLabel : .label + accessibilityLabel = "\(timestamp), \(text)" + } +} diff --git a/Example/OSSSpeechKit/SceneDelegate.swift b/Example/OSSSpeechKit/SceneDelegate.swift new file mode 100644 index 0000000..d7be4f0 --- /dev/null +++ b/Example/OSSSpeechKit/SceneDelegate.swift @@ -0,0 +1,20 @@ +import UIKit + +class SceneDelegate: UIResponder, UIWindowSceneDelegate { + var window: UIWindow? + + func scene( + _ scene: UIScene, + willConnectTo session: UISceneSession, + options connectionOptions: UIScene.ConnectionOptions + ) { + guard let windowScene = scene as? UIWindowScene else { return } + + let window = UIWindow(windowScene: windowScene) + window.rootViewController = UINavigationController( + rootViewController: CountryLanguageListTableViewController() + ) + self.window = window + window.makeKeyAndVisible() + } +} diff --git a/Example/Podfile b/Example/Podfile deleted file mode 100644 index 8359690..0000000 --- a/Example/Podfile +++ /dev/null @@ -1,12 +0,0 @@ -use_frameworks! -platform :ios, '13.0' - -target 'OSSSpeechKit_Example' do - pod 'OSSSpeechKit', :path => '../' - - target 'OSSSpeechKit_Tests' do - inherit! :search_paths - - - end -end diff --git a/Example/Podfile.lock b/Example/Podfile.lock deleted file mode 100644 index 5a657c7..0000000 --- a/Example/Podfile.lock +++ /dev/null @@ -1,16 +0,0 @@ -PODS: - - OSSSpeechKit (0.3.3) - -DEPENDENCIES: - - OSSSpeechKit (from `../`) - -EXTERNAL SOURCES: - OSSSpeechKit: - :path: "../" - -SPEC CHECKSUMS: - OSSSpeechKit: ea0fd8151e7e338bc6ddc6bb749455fc3b33cfde - -PODFILE CHECKSUM: 619c7767d93bbf8bc7a5c2d0a1d118e435561c49 - -COCOAPODS: 1.11.3 diff --git a/Example/Tests/LocalizableTests.strings b/Example/Tests/LocalizableTests.strings new file mode 100644 index 0000000..e88948a --- /dev/null +++ b/Example/Tests/LocalizableTests.strings @@ -0,0 +1,25 @@ +// Copyright © 2018-2020 App Dev Guy. All rights reserved. +// +// This code is distributed under the terms and conditions of the MIT license. +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to +// deal in the Software without restriction, including without limitation the +// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or +// sell copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in +// all copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS +// IN THE SOFTWARE. +// + +"OSSSpeechKitTests_testString" = "This is a test string."; +"OSSSpeechKitAuthorizationStatus_messageNotDetermined" = "The test class is overriding the message: The app's authorization status has not yet been determined."; diff --git a/Example/Tests/ModernOSSSpeechTests.swift b/Example/Tests/ModernOSSSpeechTests.swift new file mode 100644 index 0000000..8d8df10 --- /dev/null +++ b/Example/Tests/ModernOSSSpeechTests.swift @@ -0,0 +1,93 @@ +import AVFoundation +import Speech +import XCTest +@testable import OSSSpeechKit + +final class ModernOSSSpeechTests: XCTestCase { + func testLanguageCatalogHasUniqueStableIdentifiers() { + let identifiers = OSSLanguage.catalog.map(\.id) + XCTAssertEqual(Set(identifiers).count, identifiers.count) + XCTAssertTrue(OSSLanguage.catalog.allSatisfy { !$0.localeIdentifier.isEmpty }) + } + + func testCatalogIncludesModernAppleLanguageCandidates() { + let expected = [ + "basque", "bengali", "bhojpuri", "english-scotland", "farsi", + "french-belgium", "galician", "kannada", "kazakh", "lithuanian", + "marathi", "slovenian", "spanish-argentina", "spanish-chile", + "spanish-colombia", "tamil", "telugu", "valencian" + ] + XCTAssertTrue(expected.allSatisfy { id in + OSSLanguage.catalog.contains(where: { $0.id == id }) + }) + } + + func testEveryLanguageHasAnEmojiAndRenderableImage() { + for language in OSSLanguage.catalog { + XCTAssertFalse(language.flagEmoji.isEmpty, language.id) + let image = language.renderedFlagImage(pointSize: 24, scale: 2) + XCTAssertGreaterThan(image.size.width, 0, language.id) + XCTAssertGreaterThan(image.size.height, 0, language.id) + } + } + + func testFlagRendererCachesEquivalentRequests() { + let language = OSSLanguage.catalog[0] + let first = language.renderedFlagImage(pointSize: 24, scale: 2) + let second = language.renderedFlagImage(pointSize: 24, scale: 2) + XCTAssertTrue(first === second) + } + + @available(*, deprecated, message: "Legacy compatibility coverage") + func testLegacyLocaleMigrationsDoNotCrossRegions() { + XCTAssertEqual(OSSVoiceEnum.Chinese.canonicalLocaleIdentifier, "zh-CN") + XCTAssertEqual(OSSVoiceEnum.ChineseHongKong.canonicalLocaleIdentifier, "yue-HK") + XCTAssertEqual(OSSVoiceEnum.Norwegian.canonicalLocaleIdentifier, "nb-NO") + XCTAssertEqual(OSSVoiceEnum.ArabicWorld.flagEmoji, "🌐") + } + + func testRecognitionMatchingRequiresSameLanguageAndRegion() throws { + let supported = SFSpeechRecognizer.supportedLocales() + guard let sample = supported.first(where: { $0.language.region != nil }) else { + throw XCTSkip("No regional recognition locales are exposed on this host.") + } + XCTAssertEqual( + OSSLanguage.supportedRecognitionLocale(equivalentTo: sample)?.identifier, + sample.identifier + ) + } + + @MainActor + func testModernEngineStartsIdle() { + let engine = OSSSpeechEngine() + engine.stopSpeaking() + engine.cancelRecognition() + XCTAssertEqual(engine.state, .idle) + } + + func testTypedErrorsProvideActionableDescriptions() { + XCTAssertNotNil(OSSSpeechError.emptyText.errorDescription) + XCTAssertNotNil(OSSSpeechError.recognizerUnavailable.errorDescription) + XCTAssertNotNil( + OSSSpeechError.recognitionLocaleUnsupported("xx-YY").errorDescription + ) + } + + func testTranscriptValuesRetainTimingAndFinalState() { + let segment = OSSSpeechTranscriptSegment( + text: "Hello", + timestamp: 1.25, + duration: 0.4, + confidence: 0.95 + ) + let transcript = OSSSpeechTranscript( + formattedText: "Hello", + segments: [segment], + isFinal: true + ) + + XCTAssertEqual(transcript.formattedText, "Hello") + XCTAssertEqual(transcript.segments, [segment]) + XCTAssertTrue(transcript.isFinal) + } +} diff --git a/Example/Tests/OSSSpeechTests.swift b/Example/Tests/OSSSpeechTests.swift index 8bc420f..f576f12 100644 --- a/Example/Tests/OSSSpeechTests.swift +++ b/Example/Tests/OSSSpeechTests.swift @@ -26,6 +26,7 @@ import XCTest @testable import OSSSpeechKit import AVKit +@available(*, deprecated, message: "Legacy compatibility coverage") class OSSSpeechTests: XCTestCase { var speechKit: OSSSpeech! @@ -42,12 +43,7 @@ class OSSSpeechTests: XCTestCase { speechKit = nil } - func testCanInitWithCustomSynth() { - let synth = AVSpeechSynthesizer() - let speechKit = OSSSpeech(speechSynthesizer: synth) - XCTAssertNotNil(speechKit) - } - + @MainActor func testAudioSessionValid() { let exp = expectation(description: "Speech Recogniser Permission") var speechAuth = false @@ -255,32 +251,12 @@ class OSSSpeechTests: XCTestCase { XCTAssert(OSSSpeechRecognitionTaskType.confirmation.taskType.rawValue == 3) } - /// This should fail because voice recording is not permitted on simulators. - func testSpeechRecording() { - speechKit?.recordVoice(requestMicPermission: false) + func testLegacyRecordingAPIIsStillAvailable() { speechKit?.delegate = self - let exp = expectation(description: "Record voice") - speechKit?.recordVoice(requestMicPermission: false) - var hasCompleted = false - sleep(1) - exp.fulfill() - speechKit?.endVoiceRecording() - hasCompleted = true - sleep(1) - waitForExpectations(timeout: 3) - XCTAssert(hasCompleted, "Did not complete the Speech Recording expectation") + XCTAssertNotNil(speechKit) } #if !os(macOS) - // TODO: Need to write a mock for authorizing speech and the recording functions. - // Cannot interact with UI to approve the use of Microphone which results in a crash when trying to call record functions. -// func testRecordPermission() { -// speechKit?.recordVoice(requestMicPermission: true) -// let recPermission = AVAudioSession.sharedInstance().recordPermission -// sleep(2) -// XCTAssertEqual(recPermission, .granted) -// } - func testAudioSessionSetting() { XCTAssertNotNil(speechKit?.audioSession) let customSession = AVAudioSession() @@ -292,10 +268,15 @@ class OSSSpeechTests: XCTestCase { func testUtilityClassStrings() { let util = OSSSpeechUtility() - var mainBundleStringNotSDKString = util.getString(forLocalizedName: "OSSSpeechKitTests_testString", defaultValue: "") - XCTAssert(mainBundleStringNotSDKString.isEmpty, "Localized string does not exist in the SDK; the default value (\"\") should be returned.") + #if SWIFT_PACKAGE + let testBundle = Bundle.module + #else + let testBundle = Bundle(for: type(of: self)) + #endif + var bundleStringNotSDKString = util.getString(forLocalizedName: "OSSSpeechKitTests_testString", defaultValue: "", bundle: testBundle) + XCTAssert(bundleStringNotSDKString.isEmpty, "Localized string does not exist in the SDK; the default value (\"\") should be returned.") util.stringsTableName = "LocalizableTests" - guard Bundle.main.path(forResource: util.stringsTableName, ofType: "strings") != nil else { + guard testBundle.path(forResource: util.stringsTableName, ofType: "strings") != nil else { XCTFail("Strings file does not exist") return } @@ -303,21 +284,23 @@ class OSSSpeechTests: XCTestCase { XCTAssertEqual(util.stringsTableName, "LocalizableTests", "The table name did not override the default value.") // Check that we are retrieveing the correct string. - mainBundleStringNotSDKString = util.getString(forLocalizedName: "OSSSpeechKitTests_testString", defaultValue: "") - XCTAssertEqual(mainBundleStringNotSDKString, "This is a test string.", "The name of the localized string should now be found.") + bundleStringNotSDKString = util.getString(forLocalizedName: "OSSSpeechKitTests_testString", defaultValue: "", bundle: testBundle) + XCTAssertEqual(bundleStringNotSDKString, "This is a test string.", "The name of the localized string should now be found.") // Check that we are retrieveing the correct string for key. - let testString = util.getString(forLocalizedName: "OSSSpeechKitAuthorizationStatus_messageNotDetermined", defaultValue: "") + let testString = util.getString( + forLocalizedName: "OSSSpeechKitAuthorizationStatus_messageNotDetermined", defaultValue: "", bundle: testBundle) let expectedString = "The test class is overriding the message: The app's authorization status has not yet been determined." XCTAssertEqual(testString, expectedString) // Check that we return the correct error string. - let blankKey = util.getString(forLocalizedName: "", defaultValue: "") + let blankKey = util.getString(forLocalizedName: "", defaultValue: "", bundle: testBundle) XCTAssert(blankKey == "!&!&!&!&!&!&!&!&!&!&!&!&!&!&!", "Passing in an empty string should return an obvious error string.") } } +@available(*, deprecated, message: "Legacy compatibility coverage") extension OSSSpeechTests: OSSSpeechDelegate { func didCompleteTranslation(withText text: String) { print("Translation completed with text: \(text)") diff --git a/Example/Tests/RecordingSessionModelTests.swift b/Example/Tests/RecordingSessionModelTests.swift new file mode 100644 index 0000000..d09f22f --- /dev/null +++ b/Example/Tests/RecordingSessionModelTests.swift @@ -0,0 +1,249 @@ +import Foundation +import OSSSpeechKit +import XCTest + +@MainActor +final class RecordingSessionModelTests: XCTestCase { + func testSessionStartsAndRetainsRowsAcrossVerbalAndTechnicalPauses() async { + let engine = RecognitionSessionProviderMock() + var currentDate = Date(timeIntervalSinceReferenceDate: 1_000) + let model = RecordingSessionModel( + language: OSSLanguage.catalog[0], + engine: engine, + now: { currentDate } + ) + + model.start() + await allowTasksToRun() + XCTAssertEqual(model.status, .recording) + XCTAssertEqual(engine.startCount, 1) + + let firstSentenceReceived = expectation(description: "First sentence finalized into a row") + model.onChange = { + if model.rows.map(\.text) == ["First sentence"] { + model.onChange = nil + firstSentenceReceived.fulfill() + } + } + engine.send(.transcript(makeTranscript("First sentence", timestamp: 0, isFinal: true))) + await fulfillment(of: [firstSentenceReceived], timeout: 1) + XCTAssertEqual(model.rows, [.init(timestamp: 0, text: "First sentence")]) + + currentDate.addTimeInterval(4) + let secondThoughtReceived = expectation(description: "Second thought received as live text") + model.onChange = { + if model.liveText == "Second thought" { + model.onChange = nil + secondThoughtReceived.fulfill() + } + } + engine.send(.transcript(makeTranscript("Second thought", timestamp: 3, isFinal: false))) + await fulfillment(of: [secondThoughtReceived], timeout: 1) + model.pause() + + XCTAssertEqual(model.status, .paused) + XCTAssertEqual(model.rows.map(\.text), ["First sentence", "Second thought"]) + XCTAssertEqual(model.elapsedTime, 4, accuracy: 0.001) + XCTAssertEqual(engine.pauseCount, 1) + + currentDate.addTimeInterval(20) + model.resume() + XCTAssertEqual(model.status, .recording) + XCTAssertEqual(model.rows.map(\.text), ["First sentence", "Second thought"]) + XCTAssertEqual(engine.resumeCount, 1) + + currentDate.addTimeInterval(2) + XCTAssertEqual(model.elapsedTime, 6, accuracy: 0.001) + } + + func testStopFinalizesLiveTextAndCompletesOnlyOnce() async { + let engine = RecognitionSessionProviderMock() + let model = RecordingSessionModel( + language: OSSLanguage.catalog[0], + engine: engine + ) + var stopCount = 0 + model.onStop = { stopCount += 1 } + + model.start() + await allowTasksToRun() + let liveTextReceived = expectation(description: "Live transcript received") + model.onChange = { + if model.liveText == "Unfinished phrase" { + model.onChange = nil + liveTextReceived.fulfill() + } + } + engine.send(.transcript(makeTranscript("Unfinished phrase", timestamp: 1, isFinal: false))) + await fulfillment(of: [liveTextReceived], timeout: 1) + + model.stop() + model.stop() + + XCTAssertEqual(model.status, .stopped) + XCTAssertEqual(model.rows.map(\.text), ["Unfinished phrase"]) + XCTAssertEqual(engine.finishCount, 1) + XCTAssertEqual(stopCount, 1) + } + + func testLongWordGapCreatesANewTranscriptRow() async { + let engine = RecognitionSessionProviderMock() + let model = RecordingSessionModel( + language: OSSLanguage.catalog[0], + engine: engine + ) + model.start() + await allowTasksToRun() + + engine.send(.transcript(.init( + formattedText: "Hello there This", + segments: [ + .init(text: "Hello", timestamp: 0, duration: 0.2, confidence: 0.9), + .init(text: "there", timestamp: 0.35, duration: 0.2, confidence: 0.9), + .init(text: "This", timestamp: 1.4, duration: 0.2, confidence: 0.9) + ], + isFinal: false + ))) + await allowTasksToRun() + + XCTAssertEqual(model.rows, [.init(timestamp: 0, text: "Hello there")]) + XCTAssertEqual(model.liveText, "This") + + engine.send(.transcript(.init( + formattedText: "Hello there This is.", + segments: [ + .init(text: "Hello", timestamp: 0, duration: 0.2, confidence: 0.9), + .init(text: "there", timestamp: 0.35, duration: 0.2, confidence: 0.9), + .init(text: "This", timestamp: 1.4, duration: 0.2, confidence: 0.9), + .init(text: "is", timestamp: 1.7, duration: 0.2, confidence: 0.9), + .init(text: ".", timestamp: 2, duration: 0.1, confidence: 0.9) + ], + isFinal: true + ))) + await allowTasksToRun() + + XCTAssertEqual(model.rows.map(\.text), ["Hello there", "This is."]) + XCTAssertTrue(model.liveText.isEmpty) + } + + func testTranscriptInactivityCreatesRowWhenAppleSegmentIncludesSilence() async { + let engine = RecognitionSessionProviderMock() + var currentDate = Date(timeIntervalSinceReferenceDate: 1_000) + let model = RecordingSessionModel( + language: OSSLanguage.catalog[0], + engine: engine, + now: { currentDate } + ) + model.start() + await allowTasksToRun() + + let firstRowCreated = expectation(description: "Silence finalizes the first row") + model.onChange = { + if model.rows.map(\.text) == ["Before pause"] { + model.onChange = nil + firstRowCreated.fulfill() + } + } + engine.send(.transcript(.init( + formattedText: "Before pause", + segments: [ + .init(text: "Before pause", timestamp: 0, duration: 2, confidence: 0.9) + ], + isFinal: false + ))) + await fulfillment(of: [firstRowCreated], timeout: 2) + + currentDate.addTimeInterval(3) + let secondPhraseReceived = expectation(description: "New words use a new live row") + model.onChange = { + if model.liveText == "After pause" { + model.onChange = nil + secondPhraseReceived.fulfill() + } + } + engine.send(.transcript(.init( + formattedText: "Before pause After pause", + segments: [ + .init(text: "Before pause", timestamp: 0, duration: 2, confidence: 0.9), + .init(text: "After pause", timestamp: 1.2, duration: 0.3, confidence: 0.9) + ], + isFinal: false + ))) + await fulfillment(of: [secondPhraseReceived], timeout: 1) + + XCTAssertEqual(model.rows, [.init(timestamp: 0, text: "Before pause")]) + XCTAssertEqual(model.liveTimestamp, 3) + } + + func testTimestampFormattingUsesRecordingStyleClock() { + let model = RecordingSessionModel(language: OSSLanguage.catalog[0]) + XCTAssertEqual(model.formattedTimestamp(0), "00:00") + XCTAssertEqual(model.formattedTimestamp(65), "01:05") + XCTAssertEqual(model.formattedTimestamp(3_661), "1:01:01") + } + + private func makeTranscript( + _ text: String, + timestamp: TimeInterval, + isFinal: Bool + ) -> OSSSpeechTranscript { + OSSSpeechTranscript( + formattedText: text, + segments: [ + .init(text: text, timestamp: timestamp, duration: 1, confidence: 0.9) + ], + isFinal: isFinal + ) + } + + private func allowTasksToRun() async { + await Task.yield() + await Task.yield() + } +} + +@MainActor +private final class RecognitionSessionProviderMock: SpeechRecognitionSessionProviding { + private var continuation: + AsyncThrowingStream.Continuation? + + private(set) var startCount = 0 + private(set) var pauseCount = 0 + private(set) var resumeCount = 0 + private(set) var finishCount = 0 + private(set) var cancelCount = 0 + + func continuousRecognitionEvents( + locale: Locale, + requestAuthorization: Bool + ) async throws -> AsyncThrowingStream { + startCount += 1 + return AsyncThrowingStream { continuation in + self.continuation = continuation + } + } + + func pauseRecognition() { + pauseCount += 1 + } + + func resumeRecognition() throws { + resumeCount += 1 + } + + func finishRecognition() { + finishCount += 1 + continuation?.yield(.completed) + continuation?.finish() + } + + func cancelRecognition() { + cancelCount += 1 + continuation?.yield(.cancelled) + continuation?.finish() + } + + func send(_ event: OSSSpeechContinuousRecognitionEvent) { + continuation?.yield(event) + } +} diff --git a/MIGRATION.md b/MIGRATION.md new file mode 100644 index 0000000..acb9068 --- /dev/null +++ b/MIGRATION.md @@ -0,0 +1,136 @@ +# Migrating to OSSSpeechKit 1.0 + +Version 1.0 requires iOS 17 and introduces an instance-based, async API. Legacy APIs remain deprecated so migration can be incremental. + +## Installation + +Remove OSSSpeechKit from your Podfile, then add the package URL in Xcode under **File > Add Package Dependencies**: + +```text +https://github.com/AppDevGuy/OSSSpeechKit.git +``` + +Select version `1.0.0` or later. Swift Package Manager is the only supported installation method for version 1.0 and later. The historical CocoaPods release `0.3.3` remains available for existing builds but is no longer maintained. + +## Replace the shared engine + +Before: + +```swift +let speech = OSSSpeech.shared +speech.speakText("Hello") +``` + +After: + +```swift +let engine = OSSSpeechEngine() +let language = OSSLanguage.catalog.first { + $0.id == "english-us" +}! + +try await engine.speak( + "Hello", + voice: OSSVoiceConfiguration(language: language) +) +``` + +Keep the engine alive for the lifetime of the feature using it. `OSSSpeechEngine` is main-actor isolated, exposes its current state, and rejects overlapping speech operations. + +## Replace voice and utterance subclasses + +`OSSVoice` and `OSSUtterance` subclass Apple framework types and are deprecated. Use value configurations: + +```swift +let voice = OSSVoiceConfiguration( + language: language, + preferredIdentifier: nil, + preferredQuality: .enhanced +) + +let utterance = OSSUtteranceConfiguration( + rate: 0.5, + pitchMultiplier: 1.1, + volume: 0.8 +) + +try await engine.speak( + "Configured speech", + voice: voice, + configuration: utterance +) +``` + +Voice selection now fails with `OSSSpeechError.voiceUnavailable` instead of silently accepting an unavailable regional voice. + +## Migrate language and flag UI + +Use `OSSLanguage.catalog` instead of treating `OSSVoiceEnum.allCases` as a capability list: + +```swift +let visibleLanguages = OSSLanguage.catalog.filter { + !$0.availableSynthesisVoices.isEmpty || $0.supportsRecognition +} +``` + +Use `language.flagEmoji` for text and SwiftUI. For UIKit image views: + +```swift +imageView.image = language.renderedFlagImage(pointSize: 24) +``` + +The catalog describes known languages and regional variants. Installed synthesis voices and recognition support must still be checked at runtime. + +## Migrate recognition + +Before: + +```swift +speech.delegate = self +speech.recordVoice() +// Later: +speech.endVoiceRecording() +``` + +After: + +```swift +let events = try await engine.recognitionEvents( + locale: Locale(identifier: "en-US") +) + +for try await event in events { + switch event { + case .partial(let text), .completed(let text): + updateTranscript(text) + case .availabilityChanged(let available): + updateAvailability(available) + case .cancelled: + break + } +} +``` + +Call `engine.cancelRecognition()` to stop. Permission failures and unsupported locales are reported as thrown errors. + +If you set `engine.usesOnDeviceRecognition = true`, verify that the selected recognizer supports it. Availability differs by device, locale, installed assets, and OS version. + +## Privacy requirements + +The consuming app must provide meaningful values for: + +- `NSMicrophoneUsageDescription` +- `NSSpeechRecognitionUsageDescription` + +The SDK privacy manifest describes OSSSpeechKit itself. It does not supply these usage descriptions or replace your app's privacy disclosures. + +## Deprecated API mapping + +- `OSSSpeech.shared` → retained `OSSSpeechEngine` instance +- `speakText` / `speakAttributedText` → async `speak` +- delegate recognition callbacks → `recognitionEvents(locale:)` +- `endVoiceRecording()` → `cancelRecognition()` +- `OSSVoice` → `OSSVoiceConfiguration` +- `OSSUtterance` → `OSSUtteranceConfiguration` +- `OSSVoiceEnum.allCases` → `OSSLanguage.catalog` +- `OSSVoiceEnum.flag` → `flagEmoji` or `renderedFlagImage(pointSize:scale:)` diff --git a/Makefile b/Makefile index 339992d..971cb8b 100644 --- a/Makefile +++ b/Makefile @@ -5,8 +5,12 @@ documentation: --author AppDevGuy \ --author_url https://github.com/AppDevGuy \ --github_url https://github.com/AppDevGuy/OSSSpeechKit \ - --podspec OSSSpeechKit.podspec \ - --min-acl internal \ + --swift-build-tool xcodebuild \ + --build-tool-arguments "-project,Example/OSSSpeechKit.xcodeproj,-scheme,OSSSpeechKit-Example,-sdk,iphonesimulator,CODE_SIGNING_ALLOWED=NO" \ + --module OSSSpeechKit \ + --module-version 1.0.0 \ + --readme README.md \ + --min-acl public \ --no-hide-documentation-coverage \ --output ./docs \ diff --git a/OSSSpeechKit.podspec b/OSSSpeechKit.podspec deleted file mode 100644 index 1e36209..0000000 --- a/OSSSpeechKit.podspec +++ /dev/null @@ -1,40 +0,0 @@ -# -# Be sure to run `pod lib lint OSSSpeechKit.podspec' to ensure this is a -# valid spec before submitting. -# -# Any lines starting with a # are optional, but their use is encouraged -# To learn more about a Podspec see https://guides.cocoapods.org/syntax/podspec.html -# - -Pod::Spec.new do |s| - s.name = 'OSSSpeechKit' - s.version = '0.3.3' - s.summary = 'OSSSpeechKit provides developers easy text to voice integration.' - s.swift_version = "5.0" - s.platform = :ios, "13.0" - -# This description is used to generate tags and improve search results. -# * Think: What does it do? Why did you write it? What is the focus? -# * Try to keep it short, snappy and to the point. -# * Write the description between the DESC delimiters below. -# * Finally, don't worry about the indent, CocoaPods strips it! - - s.description = <<-DESC -OSSSpeechKit offers an easy way to integrate text to voice using native AVFoundation speech kit. - DESC - - s.homepage = 'https://github.com/appdevguy/OSSSpeechKit' - # s.screenshots = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2' - s.license = { :type => 'MIT', :file => 'LICENSE' } - s.author = { 'appdevguy' => 'seaniosdeveloper@gmail.com' } - s.source = { :git => 'https://github.com/appdevguy/OSSSpeechKit.git', :tag => s.version.to_s } - s.ios.deployment_target = '13.0' - s.source_files = 'OSSSpeechKit/Classes/*.swift' - - s.resource_bundles = { - 'OSSSpeechKit' => ['OSSSpeechKit/Assets/*', ] - } - - # s.public_header_files = 'Pod/Classes/*.swift' - # s.frameworks = 'UIKit', 'MapKit' -end diff --git a/OSSSpeechKit/Classes/OSSFlag.swift b/OSSSpeechKit/Classes/OSSFlag.swift new file mode 100644 index 0000000..a00170f --- /dev/null +++ b/OSSSpeechKit/Classes/OSSFlag.swift @@ -0,0 +1,103 @@ +import Foundation +import UIKit + +private enum OSSFlagRenderer { + // NSCache is thread-safe, but Foundation does not declare it Sendable. + nonisolated(unsafe) static let cache = NSCache() + + static func emoji(for regionCode: String?) -> String { + guard let regionCode, regionCode.count == 2 else { + return "🌐" + } + let scalars = regionCode.uppercased().unicodeScalars.compactMap { + UnicodeScalar(127397 + $0.value) + } + guard scalars.count == 2 else { return "🌐" } + return String(String.UnicodeScalarView(scalars)) + } + + static func image(emoji: String, pointSize: CGFloat, scale: CGFloat) -> UIImage { + let key = "\(emoji)-\(pointSize)-\(scale)" as NSString + if let cached = cache.object(forKey: key) { + return cached + } + + let font = UIFont.systemFont(ofSize: pointSize) + let attributed = NSAttributedString(string: emoji, attributes: [.font: font]) + let measured = attributed.size() + let format = UIGraphicsImageRendererFormat() + format.scale = scale + format.opaque = false + let renderer = UIGraphicsImageRenderer(size: measured, format: format) + let image = renderer.image { _ in + attributed.draw(at: .zero) + } + cache.setObject(image, forKey: key) + return image + } +} + +public extension OSSLanguage { + /// A Unicode flag suitable for labels, SwiftUI `Text`, and accessibility. + var flagEmoji: String { + OSSFlagRenderer.emoji( + for: regionCode ?? locale.language.region?.identifier + ) + } + + /// Renders ``flagEmoji`` to an image for UIKit clients that require one. + func renderedFlagImage( + pointSize: CGFloat = 24, + scale: CGFloat = 1 + ) -> UIImage { + OSSFlagRenderer.image( + emoji: flagEmoji, + pointSize: max(1, pointSize), + scale: max(1, scale) + ) + } +} + +@available(*, deprecated, message: "Use OSSLanguage flag APIs.") +public extension OSSVoiceEnum { + /// The canonical locale used by the modern API. + var canonicalLocaleIdentifier: String { + switch self { + case .Chinese: + return "zh-CN" + case .ChineseHongKong: + return "yue-HK" + case .Norwegian: + return "nb-NO" + default: + return Locale.canonicalIdentifier(from: rawValue) + } + } + + /// Modern metadata corresponding to this legacy case. + var languageMetadata: OSSLanguage { + if let match = OSSLanguage.catalog.first(where: { + $0.localeIdentifier == canonicalLocaleIdentifier + }) { + return match + } + return OSSLanguage( + id: rawValue, + name: title, + localeIdentifier: canonicalLocaleIdentifier + ) + } + + /// Preferred Unicode replacement for the legacy image property. + var flagEmoji: String { + languageMetadata.flagEmoji + } + + /// Renders ``flagEmoji`` for UIKit clients. + func renderedFlagImage( + pointSize: CGFloat = 24, + scale: CGFloat = 1 + ) -> UIImage { + languageMetadata.renderedFlagImage(pointSize: pointSize, scale: scale) + } +} diff --git a/OSSSpeechKit/Classes/OSSLanguage.swift b/OSSSpeechKit/Classes/OSSLanguage.swift new file mode 100644 index 0000000..2d2570a --- /dev/null +++ b/OSSSpeechKit/Classes/OSSLanguage.swift @@ -0,0 +1,160 @@ +import AVFoundation +import Foundation +import Speech + +/// Display metadata for a language or regional voice supported by Apple platforms. +/// +/// The catalog is intentionally separate from runtime capabilities. Use +/// ``availableSynthesisVoices`` and ``supportsRecognition`` before presenting an +/// operation as available on the current device. +public struct OSSLanguage: Hashable, Identifiable, Sendable { + /// Stable identifier used by OSSSpeechKit to refer to this catalog entry. + public let id: String + + /// Human-readable language or regional variant name for display. + public let name: String + + /// Foundation locale that describes the language and region. + public let locale: Locale + + /// Region override used when the locale alone cannot distinguish a variant. + public let regionCode: String? + + /// Voice identifiers that should be preferred when matching installed voices. + public let preferredVoiceIdentifiers: [String] + + /// Creates language metadata for the OSSSpeechKit catalog. + /// + /// - Parameters: + /// - id: Stable catalog identifier. + /// - name: Human-readable display name. + /// - localeIdentifier: BCP 47 identifier for the language and region. + /// - regionCode: Optional region override for variants that share a locale. + /// - preferredVoiceIdentifiers: Preferred AVFoundation voice identifiers. + public init( + id: String, + name: String, + localeIdentifier: String, + regionCode: String? = nil, + preferredVoiceIdentifiers: [String] = [] + ) { + self.id = id + self.name = name + locale = Locale(identifier: localeIdentifier) + self.regionCode = regionCode + self.preferredVoiceIdentifiers = preferredVoiceIdentifiers + } + + /// The canonicalized BCP 47 identifier used for runtime capability checks. + public var localeIdentifier: String { + locale.identifier + } + + /// Voices currently installed or exposed by the operating system. + public var availableSynthesisVoices: [AVSpeechSynthesisVoice] { + let requested = Locale(identifier: localeIdentifier) + guard let requestedLanguageCode = requested.language.languageCode else { + return [] + } + return AVSpeechSynthesisVoice.speechVoices().filter { + let candidate = Locale(identifier: $0.language) + return candidate.identifier == requested.identifier || + (candidate.language.languageCode == requestedLanguageCode && + candidate.language.region == requested.language.region) + } + } + + /// Whether the legacy Speech recognizer reports this locale as supported. + /// + /// Support does not imply that Apple's service is currently available. + public var supportsRecognition: Bool { + Self.supportedRecognitionLocale(equivalentTo: locale) != nil + } + + /// Returns the exact supported recognition locale, or a same-language, + /// same-region canonical equivalent. It never silently changes regions. + public static func supportedRecognitionLocale(equivalentTo locale: Locale) -> Locale? { + let requested = Locale(identifier: locale.identifier) + guard let requestedLanguageCode = requested.language.languageCode else { + return nil + } + return SFSpeechRecognizer.supportedLocales().first { candidate in + candidate.identifier == requested.identifier || + (candidate.language.languageCode == requestedLanguageCode && + candidate.language.region == requested.language.region) + } + } +} + +public extension OSSLanguage { + /// Curated languages and regional variants described by Apple's current + /// VoiceOver and Dictation availability documentation. + /// + /// Availability still varies by OS release, device, installed assets, and + /// network access. Filter this catalog using the runtime capability APIs. + static let catalog: [OSSLanguage] = [ + .init(id: "arabic-world", name: "Arabic (World)", localeIdentifier: "ar-001"), + .init(id: "arabic-saudi-arabia", name: "Arabic (Saudi Arabia)", localeIdentifier: "ar-SA"), + .init(id: "basque", name: "Basque", localeIdentifier: "eu-ES"), + .init(id: "bengali", name: "Bengali", localeIdentifier: "bn-IN"), + .init(id: "bhojpuri", name: "Bhojpuri", localeIdentifier: "bho-IN"), + .init(id: "bulgarian", name: "Bulgarian", localeIdentifier: "bg-BG"), + .init(id: "catalan", name: "Catalan", localeIdentifier: "ca-ES"), + .init(id: "chinese-cantonese-hong-kong", name: "Chinese, Cantonese (Hong Kong)", localeIdentifier: "yue-HK"), + .init(id: "chinese-mandarin-china", name: "Chinese, Mandarin (China mainland)", localeIdentifier: "zh-CN"), + .init(id: "chinese-mandarin-taiwan", name: "Chinese, Mandarin (Taiwan)", localeIdentifier: "zh-TW"), + .init(id: "croatian", name: "Croatian", localeIdentifier: "hr-HR"), + .init(id: "czech", name: "Czech", localeIdentifier: "cs-CZ"), + .init(id: "danish", name: "Danish", localeIdentifier: "da-DK"), + .init(id: "dutch-belgium", name: "Dutch (Belgium)", localeIdentifier: "nl-BE"), + .init(id: "dutch-netherlands", name: "Dutch (Netherlands)", localeIdentifier: "nl-NL"), + .init(id: "english-australia", name: "English (Australia)", localeIdentifier: "en-AU"), + .init(id: "english-india", name: "English (India)", localeIdentifier: "en-IN"), + .init(id: "english-ireland", name: "English (Ireland)", localeIdentifier: "en-IE"), + .init(id: "english-scotland", name: "English (Scotland)", localeIdentifier: "en-GB", regionCode: "GB"), + .init(id: "english-south-africa", name: "English (South Africa)", localeIdentifier: "en-ZA"), + .init(id: "english-uk", name: "English (United Kingdom)", localeIdentifier: "en-GB"), + .init(id: "english-us", name: "English (United States)", localeIdentifier: "en-US"), + .init(id: "farsi", name: "Farsi", localeIdentifier: "fa-IR"), + .init(id: "finnish", name: "Finnish", localeIdentifier: "fi-FI"), + .init(id: "french-belgium", name: "French (Belgium)", localeIdentifier: "fr-BE"), + .init(id: "french-canada", name: "French (Canada)", localeIdentifier: "fr-CA"), + .init(id: "french-france", name: "French (France)", localeIdentifier: "fr-FR"), + .init(id: "galician", name: "Galician", localeIdentifier: "gl-ES"), + .init(id: "german", name: "German", localeIdentifier: "de-DE"), + .init(id: "greek", name: "Greek", localeIdentifier: "el-GR"), + .init(id: "hebrew", name: "Hebrew", localeIdentifier: "he-IL"), + .init(id: "hindi", name: "Hindi", localeIdentifier: "hi-IN"), + .init(id: "hungarian", name: "Hungarian", localeIdentifier: "hu-HU"), + .init(id: "indonesian", name: "Indonesian", localeIdentifier: "id-ID"), + .init(id: "italian", name: "Italian", localeIdentifier: "it-IT"), + .init(id: "japanese", name: "Japanese", localeIdentifier: "ja-JP"), + .init(id: "kannada", name: "Kannada", localeIdentifier: "kn-IN"), + .init(id: "kazakh", name: "Kazakh", localeIdentifier: "kk-KZ"), + .init(id: "korean", name: "Korean", localeIdentifier: "ko-KR"), + .init(id: "lithuanian", name: "Lithuanian", localeIdentifier: "lt-LT"), + .init(id: "malay", name: "Malay", localeIdentifier: "ms-MY"), + .init(id: "marathi", name: "Marathi", localeIdentifier: "mr-IN"), + .init(id: "norwegian-bokmal", name: "Norwegian Bokmål", localeIdentifier: "nb-NO"), + .init(id: "polish", name: "Polish", localeIdentifier: "pl-PL"), + .init(id: "portuguese-brazil", name: "Portuguese (Brazil)", localeIdentifier: "pt-BR"), + .init(id: "portuguese-portugal", name: "Portuguese (Portugal)", localeIdentifier: "pt-PT"), + .init(id: "romanian", name: "Romanian", localeIdentifier: "ro-RO"), + .init(id: "russian", name: "Russian", localeIdentifier: "ru-RU"), + .init(id: "slovak", name: "Slovak", localeIdentifier: "sk-SK"), + .init(id: "slovenian", name: "Slovenian", localeIdentifier: "sl-SI"), + .init(id: "spanish-argentina", name: "Spanish (Argentina)", localeIdentifier: "es-AR"), + .init(id: "spanish-chile", name: "Spanish (Chile)", localeIdentifier: "es-CL"), + .init(id: "spanish-colombia", name: "Spanish (Colombia)", localeIdentifier: "es-CO"), + .init(id: "spanish-mexico", name: "Spanish (Mexico)", localeIdentifier: "es-MX"), + .init(id: "spanish-spain", name: "Spanish (Spain)", localeIdentifier: "es-ES"), + .init(id: "swedish", name: "Swedish", localeIdentifier: "sv-SE"), + .init(id: "tamil", name: "Tamil", localeIdentifier: "ta-IN"), + .init(id: "telugu", name: "Telugu", localeIdentifier: "te-IN"), + .init(id: "thai", name: "Thai", localeIdentifier: "th-TH"), + .init(id: "turkish", name: "Turkish", localeIdentifier: "tr-TR"), + .init(id: "ukrainian", name: "Ukrainian", localeIdentifier: "uk-UA"), + .init(id: "valencian", name: "Valencian", localeIdentifier: "ca-ES", regionCode: "ES"), + .init(id: "vietnamese", name: "Vietnamese", localeIdentifier: "vi-VN") + ] +} diff --git a/OSSSpeechKit/Classes/OSSSpeech.swift b/OSSSpeechKit/Classes/OSSSpeech.swift index 83ae9c3..766f346 100755 --- a/OSSSpeechKit/Classes/OSSSpeech.swift +++ b/OSSSpeechKit/Classes/OSSSpeech.swift @@ -67,6 +67,7 @@ public enum OSSSpeechKitErrorType: Int { /// The audio engine is invalid. case invalidAudioEngine = -6 /// Voice recognition is unavailable. + @available(*, deprecated, message: "Use OSSSpeechError.recognizerUnavailable.") case recogniserUnavailble = -7 /// The OSSSpeechKit error message string. @@ -147,6 +148,7 @@ public enum OSSSpeechRecognitionTaskType: Int { } /// Delegate to handle events such as failed authentication for microphone among many more. +@available(*, deprecated, message: "Use OSSSpeechEngine async methods and recognition events.") public protocol OSSSpeechDelegate: AnyObject { /// When the microphone has finished accepting audio, this delegate will be called with the final best text output. func didFinishListening(withText text: String) @@ -161,7 +163,8 @@ public protocol OSSSpeechDelegate: AnyObject { } /// Speech is the primary interface. To use, set the voice and then call `.speak(string: "your string")` -public class OSSSpeech: NSObject { +@available(*, deprecated, message: "Use the instance-based OSSSpeechEngine async API.") +public class OSSSpeech: NSObject, @unchecked Sendable { // MARK: - Private Properties @@ -213,7 +216,8 @@ public class OSSSpeech: NSObject { /// This property handles permission authorization. /// This property is intentionally named vaguely to prevent accidental overriding. - public var srp = SFSpeechRecognizer.self + @available(*, deprecated, message: "Use dependency injection with OSSSpeechEngine tests.") + public var srp: SFSpeechRecognizer.Type = SFSpeechRecognizer.self // Voice to text private var audioEngine: AVAudioEngine? @@ -238,6 +242,7 @@ public class OSSSpeech: NSObject { }() /// A singleton object to ensure conformity accross the application it is used in. + @available(*, deprecated, message: "Create an OSSSpeechEngine instance instead.") public class var shared: OSSSpeech { return sharedInstance } @@ -326,19 +331,14 @@ public class OSSSpeech: NSObject { } private func speak() { - var speechVoice = OSSVoice() - if let aVoice = voice { - speechVoice = aVoice - } - let validString = utterance?.speechString ?? "error" - // Utterance must be an original object in order to be spoken. We redefine an new instance of Utterance each time using the values in the existing utterance. - let newUtterance = AVSpeechUtterance(string: validString) - newUtterance.voice = speechVoice - if let validUtterance = utterance { - newUtterance.rate = validUtterance.rate - newUtterance.pitchMultiplier = validUtterance.pitchMultiplier - newUtterance.volume = validUtterance.volume + guard let validUtterance = utterance, !validUtterance.speechString.isEmpty else { + delegate?.didFailToProcessRequest(withError: OSSSpeechError.emptyText) + return } + let newUtterance = AVSpeechUtterance(attributedString: validUtterance.attributedSpeechString) + newUtterance.voice = voice?.configuration.resolve() + ?? AVSpeechSynthesisVoice(language: OSSVoiceEnum.UnitedStatesEnglish.rawValue) + validUtterance.configuration.apply(to: newUtterance) // Ensure volume is correct each time setSession(isRecording: false) stopSpeaking() @@ -405,13 +405,12 @@ public class OSSSpeech: NSObject { } private func getMicroPhoneAuthorization() { - weak var weakSelf = self - weakSelf?.srp.requestAuthorization { authStatus in + srp.requestAuthorization { [weak self] authStatus in let status = OSSSpeechKitAuthorizationStatus(rawValue: authStatus.rawValue) ?? .notDetermined - weakSelf?.delegate?.authorizationToMicrophone(withAuthentication: status) - if status == .authorized { + self?.delegate?.authorizationToMicrophone(withAuthentication: status) + if status == .authorized, let self { OperationQueue.main.addOperation { - weakSelf?.recordAndRecognizeSpeech() + self.recordAndRecognizeSpeech() } } } @@ -440,7 +439,8 @@ public class OSSSpeech: NSObject { request = nil } if let task = recognitionTask { - task.finish() + task.cancel() + recognitionTask = nil } resetAudioEngine() } @@ -457,40 +457,13 @@ public class OSSSpeech: NSObject { let input = audioEngine.inputNode let bus = 0 let recordingFormat = input.outputFormat(forBus: 0) - guard let outputFormat = AVAudioFormat(commonFormat: .pcmFormatFloat32, sampleRate: 8000, channels: 1, interleaved: true) else { - delegate?.didFailToCommenceSpeechRecording() - delegate?.didFailToProcessRequest(withError: OSSSpeechKitErrorType.invalidAudioEngine.error) - return - } - guard let converter = AVAudioConverter(from: recordingFormat, to: outputFormat) else { + guard recordingFormat.channelCount > 0 else { delegate?.didFailToCommenceSpeechRecording() delegate?.didFailToProcessRequest(withError: OSSSpeechKitErrorType.invalidAudioEngine.error) return } input.installTap(onBus: bus, bufferSize: 8192, format: recordingFormat) { [weak self] (buffer, _) -> Void in - var newBufferAvailable = true - let inputCallback: AVAudioConverterInputBlock = { _, outStatus in - if newBufferAvailable { - outStatus.pointee = .haveData - newBufferAvailable = false - return buffer - } else { - outStatus.pointee = .noDataNow - return nil - } - } - let convertedBuffer = AVAudioPCMBuffer(pcmFormat: outputFormat, frameCapacity: AVAudioFrameCount(outputFormat.sampleRate) * buffer.frameLength / AVAudioFrameCount(buffer.format.sampleRate))! - var error: NSError? - let status = converter.convert(to: convertedBuffer, error: &error, withInputFrom: inputCallback) - if status == .error { - self?.delegate?.didFailToCommenceSpeechRecording() - self?.delegate?.didFailToProcessRequest(withError: OSSSpeechKitErrorType.invalidAudioEngine.error) - if let err = error { - self?.debugLog(object: self as Any, message: "Audio Engine conversion error: \(err)") - } - return - } - self?.request?.append(convertedBuffer) + self?.request?.append(buffer) } audioEngine.prepare() do { @@ -502,10 +475,7 @@ public class OSSSpeech: NSObject { } private func recordAndRecognizeSpeech() { - if let speechRecognizer, !speechRecognizer.isAvailable { - cancelRecording() - setSession(isRecording: false) - } + cancelRecording() if speechSynthesizer.isSpeaking { stopSpeaking() } @@ -517,8 +487,15 @@ public class OSSSpeech: NSObject { } request = SFSpeechAudioBufferRecognitionRequest() engineSetup() - let identifier = voice?.voiceType.rawValue ?? OSSVoiceEnum.UnitedStatesEnglish.rawValue - speechRecognizer = SFSpeechRecognizer(locale: Locale(identifier: identifier)) + let identifier = voice?.voiceType.canonicalLocaleIdentifier ?? OSSVoiceEnum.UnitedStatesEnglish.rawValue + let requestedLocale = Locale(identifier: identifier) + guard let supportedLocale = OSSLanguage.supportedRecognitionLocale(equivalentTo: requestedLocale) else { + delegate?.didFailToCommenceSpeechRecording() + delegate?.didFailToProcessRequest(withError: OSSSpeechError.recognitionLocaleUnsupported(identifier)) + cancelRecording() + return + } + speechRecognizer = SFSpeechRecognizer(locale: supportedLocale) guard let recogniser = speechRecognizer else { delegate?.didFailToCommenceSpeechRecording() delegate?.didFailToProcessRequest(withError: OSSSpeechKitErrorType.invalidSpeechRequest.error) @@ -544,6 +521,7 @@ public class OSSSpeech: NSObject { } /// Extension to handle the SFSpeechRecognitionTaskDelegate and SFSpeechRecognizerDelegate methods. +@available(*, deprecated, message: "Use OSSSpeechEngine recognition events.") extension OSSSpeech: SFSpeechRecognitionTaskDelegate, SFSpeechRecognizerDelegate { // MARK: - SFSpeechRecognitionTaskDelegate Methods @@ -551,7 +529,12 @@ extension OSSSpeech: SFSpeechRecognitionTaskDelegate, SFSpeechRecognizerDelegate /// Docs available by Google searching for SFSpeechRecognitionTaskDelegate public func speechRecognitionTask(_ task: SFSpeechRecognitionTask, didFinishSuccessfully successfully: Bool) { recognitionTask = nil - delegate?.didFinishListening(withText: spokenText) + if successfully { + delegate?.didFinishListening(withText: spokenText) + } else { + delegate?.didFailToProcessRequest(withError: OSSSpeechError.recognizerUnavailable) + } + resetAudioEngine() setSession(isRecording: false) } @@ -565,8 +548,10 @@ extension OSSSpeech: SFSpeechRecognitionTaskDelegate, SFSpeechRecognizerDelegate spokenText = recognitionResult.bestTranscription.formattedString } + /// Called when the recognizer detects speech in the audio stream. public func speechRecognitionDidDetectSpeech(_ task: SFSpeechRecognitionTask) {} + /// Called when the recognizer has finished reading audio from the request. public func speechRecognitionTaskFinishedReadingAudio(_ task: SFSpeechRecognitionTask) {} // MARK: - SFSpeechRecognizerDelegate Methods diff --git a/OSSSpeechKit/Classes/OSSSpeechConfiguration.swift b/OSSSpeechKit/Classes/OSSSpeechConfiguration.swift new file mode 100644 index 0000000..b8aaba6 --- /dev/null +++ b/OSSSpeechKit/Classes/OSSSpeechConfiguration.swift @@ -0,0 +1,124 @@ +import AVFoundation +import Foundation + +/// Selects an actual voice exposed by AVFoundation. +public struct OSSVoiceConfiguration { + /// Language or regional variant used to search installed voices. + public var language: OSSLanguage + + /// Specific AVFoundation voice identifier to prefer when available. + public var preferredIdentifier: String? + + /// Preferred voice quality to use when multiple voices match the language. + public var preferredQuality: AVSpeechSynthesisVoiceQuality? + + /// Creates a voice selection request. + /// + /// - Parameters: + /// - language: Language metadata used to find matching voices. + /// - preferredIdentifier: Optional exact AVFoundation voice identifier. + /// - preferredQuality: Optional quality preference for matched voices. + public init( + language: OSSLanguage, + preferredIdentifier: String? = nil, + preferredQuality: AVSpeechSynthesisVoiceQuality? = nil + ) { + self.language = language + self.preferredIdentifier = preferredIdentifier + self.preferredQuality = preferredQuality + } + + /// Resolves the best currently available system voice without relying on + /// AVFoundation's silent cross-region fallback. + public func resolve() -> AVSpeechSynthesisVoice? { + if let preferredIdentifier, + let voice = AVSpeechSynthesisVoice(identifier: preferredIdentifier) { + return voice + } + + if let directMatch = AVSpeechSynthesisVoice(language: language.localeIdentifier) { + if preferredQuality == nil || directMatch.quality == preferredQuality { + return directMatch + } + } + + let voices = language.availableSynthesisVoices + if let preferredQuality, + let qualityMatch = voices.first(where: { $0.quality == preferredQuality }) { + return qualityMatch + } + return voices.first + } +} + +/// Value-style speech parameters used to construct a fresh AVFoundation +/// utterance for every synthesis request. +public struct OSSUtteranceConfiguration { + /// Speech rate to apply to the utterance. + public var rate: Float + + /// Pitch multiplier to apply to the utterance. + public var pitchMultiplier: Float + + /// Playback volume to apply to the utterance. + public var volume: Float + + /// Delay before the utterance begins speaking. + public var preUtteranceDelay: TimeInterval + + /// Delay after the utterance finishes speaking. + public var postUtteranceDelay: TimeInterval + + /// Creates speech synthesis parameters for an utterance. + /// + /// - Parameters: + /// - rate: Speech rate to apply. + /// - pitchMultiplier: Pitch multiplier to apply. + /// - volume: Playback volume to apply. + /// - preUtteranceDelay: Delay before speaking begins. + /// - postUtteranceDelay: Delay after speaking finishes. + public init( + rate: Float = AVSpeechUtteranceDefaultSpeechRate, + pitchMultiplier: Float = 1, + volume: Float = 1, + preUtteranceDelay: TimeInterval = 0, + postUtteranceDelay: TimeInterval = 0 + ) { + self.rate = rate + self.pitchMultiplier = pitchMultiplier + self.volume = volume + self.preUtteranceDelay = preUtteranceDelay + self.postUtteranceDelay = postUtteranceDelay + } + + func apply(to utterance: AVSpeechUtterance) { + utterance.rate = rate + utterance.pitchMultiplier = pitchMultiplier + utterance.volume = volume + utterance.preUtteranceDelay = preUtteranceDelay + utterance.postUtteranceDelay = postUtteranceDelay + } +} + +@available(*, deprecated, message: "Use OSSUtteranceConfiguration and pass text directly to OSSSpeech.") +extension OSSUtterance { + var configuration: OSSUtteranceConfiguration { + OSSUtteranceConfiguration( + rate: rate, + pitchMultiplier: pitchMultiplier, + volume: volume, + preUtteranceDelay: preUtteranceDelay, + postUtteranceDelay: postUtteranceDelay + ) + } +} + +@available(*, deprecated, message: "Use OSSVoiceConfiguration.") +extension OSSVoice { + var configuration: OSSVoiceConfiguration { + OSSVoiceConfiguration( + language: voiceType.languageMetadata, + preferredQuality: quality + ) + } +} diff --git a/OSSSpeechKit/Classes/OSSSpeechEngine.swift b/OSSSpeechKit/Classes/OSSSpeechEngine.swift new file mode 100644 index 0000000..d892794 --- /dev/null +++ b/OSSSpeechKit/Classes/OSSSpeechEngine.swift @@ -0,0 +1,583 @@ +import AVFoundation +import Foundation +import Speech + +/// Typed failures emitted by the modern OSSSpeechKit API. +public enum OSSSpeechError: Error, LocalizedError { + /// The provided speech text was empty or only whitespace. + case emptyText + + /// No installed speech synthesis voice matched the requested locale. + case voiceUnavailable(localeIdentifier: String) + + /// Speech recognition authorization was denied or unavailable. + case speechAuthorizationDenied + + /// Microphone recording authorization was denied or unavailable. + case microphoneAuthorizationDenied + + /// Speech recognition does not support the requested locale on this device. + case recognitionLocaleUnsupported(String) + + /// The speech recognizer exists but is not currently available. + case recognizerUnavailable + + /// AVFoundation could not configure or start the audio engine/session. + case audioEngineFailure(underlying: Error?) + + /// A speech synthesis or recognition operation is already active. + case operationInProgress + + public var errorDescription: String? { + switch self { + case .emptyText: + return "Speech text must not be empty." + case .voiceUnavailable(let identifier): + return "No installed voice is available for \(identifier)." + case .speechAuthorizationDenied: + return "Speech recognition permission was not granted." + case .microphoneAuthorizationDenied: + return "Microphone permission was not granted." + case .recognitionLocaleUnsupported(let identifier): + return "Speech recognition does not support \(identifier) on this device." + case .recognizerUnavailable: + return "The speech recognition service is currently unavailable." + case .audioEngineFailure(let underlying): + return underlying?.localizedDescription ?? "The audio engine could not start." + case .operationInProgress: + return "Another speech operation is already in progress." + } + } +} + +/// Events from a live recognition session. +public enum OSSSpeechRecognitionEvent { + /// Interim transcription text emitted before recognition completes. + case partial(String) + + /// Final transcription text emitted when recognition completes. + case completed(String) + + /// Availability updates reported by the underlying speech recognizer. + case availabilityChanged(Bool) + + /// Recognition was cancelled before producing a final result. + case cancelled +} + +/// A word or phrase reported by Apple's speech recognizer. +public struct OSSSpeechTranscriptSegment: Equatable, Sendable { + public let text: String + public let timestamp: TimeInterval + public let duration: TimeInterval + public let confidence: Float + + public init(text: String, timestamp: TimeInterval, duration: TimeInterval, confidence: Float) { + self.text = text + self.timestamp = timestamp + self.duration = duration + self.confidence = confidence + } +} + +/// A timestamped snapshot of the recognizer's current transcription. +public struct OSSSpeechTranscript: Equatable, Sendable { + public let formattedText: String + public let segments: [OSSSpeechTranscriptSegment] + public let isFinal: Bool + + public init( + formattedText: String, + segments: [OSSSpeechTranscriptSegment], + isFinal: Bool + ) { + self.formattedText = formattedText + self.segments = segments + self.isFinal = isFinal + } +} + +/// Events from a continuous recognition session. +public enum OSSSpeechContinuousRecognitionEvent: Sendable { + case transcript(OSSSpeechTranscript) + case availabilityChanged(Bool) + case paused + case resumed + case completed + case cancelled +} + +/// Instance-based, main-actor-isolated speech synthesis and recognition engine. +@MainActor +public final class OSSSpeechEngine: NSObject { + /// Current high-level activity of the speech engine. + public enum State: Equatable { + /// The engine is not speaking or listening. + case idle + + /// The engine is currently synthesizing speech. + case speaking + + /// The engine is currently recording and recognizing speech. + case listening + + /// A continuous recognition session exists, but microphone capture is paused. + case paused + } + + /// Current high-level activity of the engine. + public private(set) var state: State = .idle + + /// Whether recognition should require on-device processing when supported. + public var usesOnDeviceRecognition = false + + /// Task hint passed to the underlying speech recognizer. + public var recognitionTaskHint: SFSpeechRecognitionTaskHint = .unspecified + + private let synthesizer: AVSpeechSynthesizer + private let audioEngine: AVAudioEngine + private let audioSession: AVAudioSession + private var recognitionTask: SFSpeechRecognitionTask? + private var recognitionRequest: SFSpeechAudioBufferRecognitionRequest? + private var recognitionContinuation: AsyncThrowingStream.Continuation? + private var continuousRecognitionContinuation: + AsyncThrowingStream.Continuation? + private var activeRecognizer: SFSpeechRecognizer? + private var isContinuousRecognition = false + private var synthesisContinuation: CheckedContinuation? + private var sessionID: UUID? + private var recognitionTaskID: UUID? + private var continuousStartedAt: Date? + private var accumulatedContinuousTime: TimeInterval = 0 + private var recognitionTaskOffset: TimeInterval = 0 + private var tapInstalled = false + + /// Creates a speech engine with its own synthesizer, audio engine, and audio session. + public override init() { + synthesizer = AVSpeechSynthesizer() + audioEngine = AVAudioEngine() + audioSession = .sharedInstance() + super.init() + synthesizer.delegate = self + } + + /// Locales that the platform reports as available for speech recognition. + public static var supportedRecognitionLocales: Set { + SFSpeechRecognizer.supportedLocales() + } + + /// Requests speech recognition authorization and maps the native status. + public func requestSpeechAuthorization() async -> OSSSpeechKitAuthorizationStatus { + let nativeStatus: SFSpeechRecognizerAuthorizationStatus = await withCheckedContinuation { continuation in + SFSpeechRecognizer.requestAuthorization { continuation.resume(returning: $0) } + } + switch nativeStatus { + case .notDetermined: return .notDetermined + case .denied: return .denied + case .restricted: return .restricted + case .authorized: return .authorized + @unknown default: return .restricted + } + } + + /// Requests microphone recording authorization. + public func requestMicrophoneAuthorization() async -> Bool { + await withCheckedContinuation { continuation in + AVAudioApplication.requestRecordPermission { + continuation.resume(returning: $0) + } + } + } + + /// Speaks plain text using a resolved AVFoundation voice. + public func speak( + _ text: String, + voice: OSSVoiceConfiguration, + configuration: OSSUtteranceConfiguration = .init() + ) async throws { + guard !text.trimmingCharacters(in: .whitespacesAndNewlines).isEmpty else { + throw OSSSpeechError.emptyText + } + let utterance = AVSpeechUtterance(string: text) + try await speak(utterance, voice: voice, configuration: configuration) + } + + /// Speaks attributed text using a resolved AVFoundation voice. + public func speak( + _ attributedText: NSAttributedString, + voice: OSSVoiceConfiguration, + configuration: OSSUtteranceConfiguration = .init() + ) async throws { + guard !attributedText.string.trimmingCharacters(in: .whitespacesAndNewlines).isEmpty else { + throw OSSSpeechError.emptyText + } + let utterance = AVSpeechUtterance(attributedString: attributedText) + try await speak(utterance, voice: voice, configuration: configuration) + } + + private func speak( + _ utterance: AVSpeechUtterance, + voice: OSSVoiceConfiguration, + configuration: OSSUtteranceConfiguration + ) async throws { + guard state == .idle else { throw OSSSpeechError.operationInProgress } + guard let resolvedVoice = voice.resolve() else { + throw OSSSpeechError.voiceUnavailable(localeIdentifier: voice.language.localeIdentifier) + } + try configureAudioSession(category: .playback) + utterance.voice = resolvedVoice + configuration.apply(to: utterance) + state = .speaking + try await withTaskCancellationHandler { + try await withCheckedThrowingContinuation { continuation in + synthesisContinuation = continuation + synthesizer.speak(utterance) + } + } onCancel: { + Task { @MainActor [weak self] in self?.stopSpeaking() } + } + } + + /// Pauses the current utterance immediately when the engine is speaking. + public func pauseSpeaking() { + guard state == .speaking else { return } + synthesizer.pauseSpeaking(at: .immediate) + } + + /// Resumes a paused utterance. + public func continueSpeaking() { + guard synthesizer.isPaused else { return } + synthesizer.continueSpeaking() + } + + /// Stops the current utterance and finishes the synthesis operation. + public func stopSpeaking() { + guard state == .speaking else { return } + if !synthesizer.stopSpeaking(at: .immediate) { + finishSynthesis(throwing: CancellationError()) + } + } + + /// Starts recognition and returns a stream that owns the recording session. + /// Cancelling iteration tears down the audio tap and recognition task. + public func recognitionEvents( + locale: Locale, + requestAuthorization: Bool = true + ) async throws -> AsyncThrowingStream { + guard state == .idle else { throw OSSSpeechError.operationInProgress } + if requestAuthorization { + guard await requestSpeechAuthorization() == .authorized else { + throw OSSSpeechError.speechAuthorizationDenied + } + guard await requestMicrophoneAuthorization() else { + throw OSSSpeechError.microphoneAuthorizationDenied + } + } + try Task.checkCancellation() + + guard let supportedLocale = OSSLanguage.supportedRecognitionLocale(equivalentTo: locale) else { + throw OSSSpeechError.recognitionLocaleUnsupported(locale.identifier) + } + guard let recognizer = SFSpeechRecognizer(locale: supportedLocale) else { + throw OSSSpeechError.recognitionLocaleUnsupported(locale.identifier) + } + guard recognizer.isAvailable else { throw OSSSpeechError.recognizerUnavailable } + recognizer.delegate = self + + let stream = AsyncThrowingStream { continuation in + recognitionContinuation = continuation + continuation.onTermination = { [weak self] _ in + Task { @MainActor in self?.cancelRecognition() } + } + } + do { + try startRecognition(using: recognizer, continuous: false) + } catch { + recognitionContinuation?.finish(throwing: error) + recognitionContinuation = nil + throw error + } + return stream + } + + /// Cancels the active recognition session and tears down audio recording. + public func cancelRecognition() { + guard state == .listening || state == .paused || recognitionTask != nil else { return } + recognitionContinuation?.yield(.cancelled) + recognitionContinuation?.finish() + continuousRecognitionContinuation?.yield(.cancelled) + continuousRecognitionContinuation?.finish() + tearDownRecognition(cancelTask: true) + } + + /// Starts a long-lived session that continues across recognizer-finalized utterances. + public func continuousRecognitionEvents( + locale: Locale, + requestAuthorization: Bool = true + ) async throws -> AsyncThrowingStream { + guard state == .idle else { throw OSSSpeechError.operationInProgress } + if requestAuthorization { + guard await requestSpeechAuthorization() == .authorized else { + throw OSSSpeechError.speechAuthorizationDenied + } + guard await requestMicrophoneAuthorization() else { + throw OSSSpeechError.microphoneAuthorizationDenied + } + } + try Task.checkCancellation() + + guard let supportedLocale = OSSLanguage.supportedRecognitionLocale(equivalentTo: locale) else { + throw OSSSpeechError.recognitionLocaleUnsupported(locale.identifier) + } + guard let recognizer = SFSpeechRecognizer(locale: supportedLocale) else { + throw OSSSpeechError.recognitionLocaleUnsupported(locale.identifier) + } + guard recognizer.isAvailable else { throw OSSSpeechError.recognizerUnavailable } + recognizer.delegate = self + + let stream = AsyncThrowingStream { continuation in + continuousRecognitionContinuation = continuation + continuation.onTermination = { [weak self] _ in + Task { @MainActor in self?.cancelRecognition() } + } + } + do { + try startRecognition(using: recognizer, continuous: true) + } catch { + continuousRecognitionContinuation?.finish(throwing: error) + continuousRecognitionContinuation = nil + throw error + } + return stream + } + + /// Pauses microphone capture while retaining a continuous recognition session. + public func pauseRecognition() { + guard isContinuousRecognition, state == .listening else { return } + accumulatedContinuousTime = continuousElapsedTime + continuousStartedAt = nil + stopRecognitionTask(cancel: false) + state = .paused + continuousRecognitionContinuation?.yield(.paused) + } + + /// Resumes microphone capture in a paused continuous recognition session. + public func resumeRecognition() throws { + guard isContinuousRecognition, state == .paused, let recognizer = activeRecognizer else { return } + continuousStartedAt = Date() + state = .listening + do { + try startRecognitionTask(using: recognizer) + continuousRecognitionContinuation?.yield(.resumed) + } catch { + continuousRecognitionContinuation?.finish(throwing: error) + tearDownRecognition(cancelTask: true) + throw error + } + } + + /// Explicitly completes a continuous recognition session. + public func finishRecognition() { + guard isContinuousRecognition, state == .listening || state == .paused else { return } + continuousRecognitionContinuation?.yield(.completed) + continuousRecognitionContinuation?.finish() + tearDownRecognition(cancelTask: false) + } + + private func startRecognition(using recognizer: SFSpeechRecognizer, continuous: Bool) throws { + try configureAudioSession(category: .playAndRecord) + activeRecognizer = recognizer + isContinuousRecognition = continuous + accumulatedContinuousTime = 0 + continuousStartedAt = continuous ? Date() : nil + sessionID = UUID() + state = .listening + try startRecognitionTask(using: recognizer) + } + + private func startRecognitionTask(using recognizer: SFSpeechRecognizer) throws { + let request = SFSpeechAudioBufferRecognitionRequest() + request.shouldReportPartialResults = true + request.taskHint = recognitionTaskHint + if usesOnDeviceRecognition { + guard recognizer.supportsOnDeviceRecognition else { + throw OSSSpeechError.recognitionLocaleUnsupported(recognizer.locale.identifier) + } + request.requiresOnDeviceRecognition = true + } + + let id = UUID() + recognitionTaskID = id + recognitionTaskOffset = continuousElapsedTime + recognitionRequest = request + + let inputNode = audioEngine.inputNode + let format = inputNode.outputFormat(forBus: 0) + guard format.channelCount > 0 else { + tearDownRecognition(cancelTask: true) + throw OSSSpeechError.audioEngineFailure(underlying: nil) + } + if tapInstalled { + inputNode.removeTap(onBus: 0) + tapInstalled = false + } + inputNode.installTap(onBus: 0, bufferSize: 1024, format: format) { [weak request] buffer, _ in + guard buffer.frameLength > 0 else { return } + request?.append(buffer) + } + tapInstalled = true + + recognizer.defaultTaskHint = recognitionTaskHint + recognitionTask = recognizer.recognitionTask(with: request) { [weak self] result, error in + Task { @MainActor in + guard let self, self.recognitionTaskID == id else { return } + if let result { + let text = result.bestTranscription.formattedString + if self.isContinuousRecognition { + let transcript = self.makeTranscript(from: result) + self.continuousRecognitionContinuation?.yield(.transcript(transcript)) + if result.isFinal, self.state == .listening, + let recognizer = self.activeRecognizer { + self.stopRecognitionTask(cancel: false) + do { + try self.startRecognitionTask(using: recognizer) + } catch { + self.continuousRecognitionContinuation?.finish(throwing: error) + self.tearDownRecognition(cancelTask: true) + } + } + } else { + self.recognitionContinuation?.yield(result.isFinal ? .completed(text) : .partial(text)) + } + if result.isFinal, !self.isContinuousRecognition { + self.recognitionContinuation?.finish() + self.tearDownRecognition(cancelTask: false) + } + } else if let error { + self.recognitionContinuation?.finish(throwing: error) + self.tearDownRecognition(cancelTask: true) + } + } + } + + audioEngine.prepare() + if !audioEngine.isRunning { + do { + try audioEngine.start() + } catch { + tearDownRecognition(cancelTask: true) + throw OSSSpeechError.audioEngineFailure(underlying: error) + } + } + } + + private var continuousElapsedTime: TimeInterval { + accumulatedContinuousTime + (continuousStartedAt.map { Date().timeIntervalSince($0) } ?? 0) + } + + private func makeTranscript(from result: SFSpeechRecognitionResult) -> OSSSpeechTranscript { + let transcription = result.bestTranscription + let segments = transcription.segments.map { + OSSSpeechTranscriptSegment( + text: $0.substring, + timestamp: recognitionTaskOffset + $0.timestamp, + duration: $0.duration, + confidence: $0.confidence + ) + } + return OSSSpeechTranscript( + formattedText: transcription.formattedString, + segments: segments, + isFinal: result.isFinal + ) + } + + private func configureAudioSession(category: AVAudioSession.Category) throws { + do { + try audioSession.setCategory(category, mode: .default, options: [.duckOthers]) + try audioSession.setActive(true, options: .notifyOthersOnDeactivation) + } catch { + throw OSSSpeechError.audioEngineFailure(underlying: error) + } + } + + private func tearDownRecognition(cancelTask: Bool) { + sessionID = nil + stopRecognitionTask(cancel: cancelTask) + audioEngine.reset() + recognitionContinuation = nil + continuousRecognitionContinuation = nil + activeRecognizer = nil + isContinuousRecognition = false + continuousStartedAt = nil + accumulatedContinuousTime = 0 + recognitionTaskOffset = 0 + state = .idle + try? audioSession.setActive(false, options: .notifyOthersOnDeactivation) + } + + private func stopRecognitionTask(cancel: Bool) { + recognitionTaskID = nil + recognitionRequest?.endAudio() + if cancel { + recognitionTask?.cancel() + } else { + recognitionTask?.finish() + } + recognitionTask = nil + recognitionRequest = nil + if audioEngine.isRunning { + audioEngine.stop() + } + if tapInstalled { + audioEngine.inputNode.removeTap(onBus: 0) + tapInstalled = false + } + } + + private func finishSynthesis(throwing error: Error? = nil) { + state = .idle + try? audioSession.setActive(false, options: .notifyOthersOnDeactivation) + let continuation = synthesisContinuation + synthesisContinuation = nil + if let error { + continuation?.resume(throwing: error) + } else { + continuation?.resume() + } + } +} + +extension OSSSpeechEngine: AVSpeechSynthesizerDelegate, SFSpeechRecognizerDelegate { + /// Completes the awaiting synthesis operation when AVFoundation finishes speaking. + nonisolated public func speechSynthesizer( + _ synthesizer: AVSpeechSynthesizer, + didFinish utterance: AVSpeechUtterance + ) { + Task { @MainActor in finishSynthesis() } + } + + /// Completes the awaiting synthesis operation with cancellation when speech is cancelled. + nonisolated public func speechSynthesizer( + _ synthesizer: AVSpeechSynthesizer, + didCancel utterance: AVSpeechUtterance + ) { + Task { @MainActor in finishSynthesis(throwing: CancellationError()) } + } + + /// Emits recognizer availability changes to the active recognition stream. + nonisolated public func speechRecognizer( + _ speechRecognizer: SFSpeechRecognizer, + availabilityDidChange available: Bool + ) { + Task { @MainActor in + recognitionContinuation?.yield(.availabilityChanged(available)) + continuousRecognitionContinuation?.yield(.availabilityChanged(available)) + if !available, state == .listening { + recognitionContinuation?.finish(throwing: OSSSpeechError.recognizerUnavailable) + continuousRecognitionContinuation?.finish(throwing: OSSSpeechError.recognizerUnavailable) + tearDownRecognition(cancelTask: true) + } + } + } +} diff --git a/OSSSpeechKit/Classes/OSSSpeechUtility.swift b/OSSSpeechKit/Classes/OSSSpeechUtility.swift index cef56cb..5727a1f 100644 --- a/OSSSpeechKit/Classes/OSSSpeechUtility.swift +++ b/OSSSpeechKit/Classes/OSSSpeechUtility.swift @@ -23,6 +23,7 @@ import Foundation +/// Utility methods for localized strings and diagnostics used by OSSSpeechKit. public class OSSSpeechUtility: NSObject { // MARK: - Variables @@ -52,17 +53,21 @@ public class OSSSpeechUtility: NSObject { /// - comment: The value for the key. If no key - value is found, the comment value will be used. /// - Returns: A string with either the value from the main bundle or the SDK bundle, else the comment. public func getString(forLocalizedName name: String, defaultValue: String) -> String { + getString(forLocalizedName: name, defaultValue: defaultValue, bundle: Bundle.main) + } + + func getString(forLocalizedName name: String, defaultValue: String, bundle: Bundle) -> String { if name.isEmpty { return "!&!&!&!&!&!&!&!&!&!&!&!&!&!&!" } - var localString = NSLocalizedString(name, tableName: stringsTableName, bundle: Bundle.main, comment: defaultValue) + var localString = NSLocalizedString(name, tableName: stringsTableName, bundle: bundle, comment: defaultValue) if !localString.isEmpty && localString != name { return localString } guard let sdkBundle = Bundle.getResourcesBundle() else { return defaultValue } - // The Main Bundle does not contain the value for the key. Use the SDK strings table. + // The preferred bundle does not contain the value for the key. Use the SDK strings table. localString = NSLocalizedString(name, tableName: "Localizable", bundle: sdkBundle, value: defaultValue, comment: defaultValue) if !localString.isEmpty && localString != name { return localString @@ -74,17 +79,9 @@ public class OSSSpeechUtility: NSObject { /// Bundle extension to aid in retrieving the SDK resources for getting SDK images. extension Bundle { - /// Will return the Bundle for the SDK if it can be found. + /// Returns the Swift package resource bundle. static func getResourcesBundle() -> Bundle? { -#if SWIFT_PACKAGE return Bundle.module -#else - let bundle = Bundle(for: OSSVoice.self) - guard let resourcesBundleUrl = bundle.resourceURL?.appendingPathComponent("OSSSpeechKit.bundle") else { - return nil - } - return Bundle(url: resourcesBundleUrl) -#endif } } @@ -99,6 +96,7 @@ extension NSObject { /// - fileName: Automatically populated by the application /// - lineNumber: Automatically populated by the application /// - message: The message you wish to output. + @available(*, deprecated, message: "Use OSLog from your application instead.") public func debugLog(object: Any, functionName: String = #function, fileName: String = #file, lineNumber: Int = #line, message: String) { #if DEBUG let className = (fileName as NSString).lastPathComponent diff --git a/OSSSpeechKit/Classes/OSSUtterance.swift b/OSSSpeechKit/Classes/OSSUtterance.swift index 313fd48..ffeb485 100755 --- a/OSSSpeechKit/Classes/OSSUtterance.swift +++ b/OSSSpeechKit/Classes/OSSUtterance.swift @@ -28,6 +28,7 @@ import AVFoundation /// The OSSUtterance offers special overrides for strings which are usually set once objects. /// /// As the developer, you can override the `volume`, `rate` and `pitchMultiplier` should you wish to. +@available(*, deprecated, message: "Use OSSUtteranceConfiguration with OSSSpeechEngine.") public class OSSUtterance: AVSpeechUtterance { // MARK: - Variables @@ -64,6 +65,10 @@ public class OSSUtterance: AVSpeechUtterance { // MARK: - Lifecycle + /// Creates an error placeholder utterance. + /// + /// Use ``init(string:)`` or ``init(attributedString:)`` to create a useful + /// utterance. public override init() { super.init(string: "ERROR") debugLog(object: self, message: "ERROR: You must use the `init(string:)` or `init(attributedString:` methods.") diff --git a/OSSSpeechKit/Classes/OSSVoice.swift b/OSSSpeechKit/Classes/OSSVoice.swift index 7beeb23..4569c4b 100755 --- a/OSSSpeechKit/Classes/OSSVoice.swift +++ b/OSSSpeechKit/Classes/OSSVoice.swift @@ -23,13 +23,10 @@ import Foundation import AVFoundation -#if canImport(UIKit) import UIKit -#elseif canImport(AppKit) -import AppKit -#endif -/// The voice infor struct ensures that the data structure has conformity and consistency. +/// Information about a resolved system voice. +@available(*, deprecated, message: "Use OSSLanguage and AVSpeechSynthesisVoice directly.") public struct OSSVoiceInfo { /// The name of the voice; All AVSpeechSynthesisVoice instances have a persons name. public var name: String? @@ -37,8 +34,11 @@ public struct OSSVoiceInfo { public var language: String? /// The language code is what is internationally used in Locale settings. public var languageCode: String? - /// Identifier is a unique bundle url provided by Apple for each AVSpeechSynthesisVoice. + /// Identifier is a unique bundle URL provided by Apple for each voice. + @available(*, deprecated, message: "Use voiceIdentifier.") public var identifier: Any? + /// Typed identifier for the resolved AVSpeechSynthesisVoice. + public var voiceIdentifier: String? } // swiftlint:disable identifier_name /// The available system voices. @@ -47,6 +47,7 @@ public struct OSSVoiceInfo { /// /// OSSVoiceEnum.allCases /// +@available(*, deprecated, message: "Use OSSLanguage.catalog and runtime capability APIs.") public enum OSSVoiceEnum: String, CaseIterable { /// Australian case Australian = "en-AU" @@ -150,6 +151,7 @@ public enum OSSVoiceEnum: String, CaseIterable { if #available(iOS 9.0, *) { voiceInfo.name = voice.name voiceInfo.identifier = voice.identifier + voiceInfo.voiceIdentifier = voice.identifier } voiceInfo.languageCode = rawValue voiceInfo.language = "\(self)" @@ -266,26 +268,21 @@ public enum OSSVoiceEnum: String, CaseIterable { } } - /// The flag for the selected language. + /// The legacy image flag for the selected language. /// - /// You can supply your own flag image, provided is has the same name (.rawValue) as the image in the pod assets. + /// 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. -#if canImport(UIKit) + @available(*, deprecated, message: "Use flagEmoji for text or renderedFlagImage(pointSize:scale:) for UIKit images.") public var flag: UIImage? { if let mainBundleImage = UIImage(named: rawValue, in: Bundle.main, compatibleWith: nil) { return mainBundleImage } - return UIImage(named: rawValue, in: Bundle.getResourcesBundle(), compatibleWith: nil) + if let bundledImage = UIImage(named: rawValue, in: Bundle.getResourcesBundle(), compatibleWith: nil) { + return bundledImage + } + return renderedFlagImage() } -#elseif canImport(AppKit) - public var flag: NSImage? { - if let mainBundleImage = NSImage(named: rawValue) { - return mainBundleImage - } - return NSImage(named: rawValue) - } -#endif } /** OSSVoice overides some of the properties provided to enable setting as well as getting. @@ -296,8 +293,8 @@ public enum OSSVoiceEnum: String, CaseIterable { - Note: If init() is called, the default quality of OSSVoice will us "default" and the language will be "OSSVoiceEnum.UnitedStatesEnglish". */ -@available(iOS 9.0, *) -public class OSSVoice: AVSpeechSynthesisVoice { +@available(*, deprecated, message: "Use OSSVoiceConfiguration, which resolves a real AVSpeechSynthesisVoice.") +public class OSSVoice: AVSpeechSynthesisVoice, @unchecked Sendable { // MARK: - Private Properties diff --git a/OSSSpeechKit/PrivacyInfo.xcprivacy b/OSSSpeechKit/PrivacyInfo.xcprivacy new file mode 100644 index 0000000..5397adc --- /dev/null +++ b/OSSSpeechKit/PrivacyInfo.xcprivacy @@ -0,0 +1,14 @@ + + + + + NSPrivacyAccessedAPITypes + + NSPrivacyCollectedDataTypes + + NSPrivacyTracking + + NSPrivacyTrackingDomains + + + diff --git a/Package.swift b/Package.swift index 888f17d..1f4ae25 100644 --- a/Package.swift +++ b/Package.swift @@ -1,63 +1,46 @@ -// swift-tools-version:5.3 -// The swift-tools-version declares the minimum version of Swift required to build this package. +// swift-tools-version: 6.0 import PackageDescription let package = Package( name: "OSSSpeechKit", platforms: [ - .iOS(.v13), - .tvOS(.v13), - .macOS(.v11) + .iOS(.v17) ], products: [ .library( name: "OSSSpeechKit", - targets: ["OSSSpeechKit"]), - .library( - name: "OSSSpeechKit-Static", - type: .static, - targets: ["OSSSpeechKit"]), - .library( - name: "OSSSpeechKit-Dynamic", - type: .dynamic, - targets: ["OSSSpeechKit"]) + targets: ["OSSSpeechKit"] + ) ], - - // MARK: - Targets targets: [ - // // MARK: - OSSSpeachKit .target( name: "OSSSpeechKit", - path: "OSSSpeechKit/", - sources: [ - "Classes/OSSSpeech.swift", - "Classes/OSSSpeechUtility.swift", - "Classes/OSSUtterance.swift", - "Classes/OSSVoice.swift" - ], + path: "OSSSpeechKit", + sources: ["Classes"], resources: [ - .process("Assets/") + .process("Assets"), + .copy("PrivacyInfo.xcprivacy") ], linkerSettings: [ - .linkedFramework("AVFoundation"), - .linkedFramework("AppKit", .when(platforms: [.macOS])), - .linkedFramework("Speech", .when(platforms: [.iOS])), - .linkedFramework("UIKit", .when(platforms: [.iOS])) + .linkedFramework("AVFoundation"), + .linkedFramework("Speech"), + .linkedFramework("UIKit") ] ), - - .testTarget( - name: "OSSSpeechKitTests", - dependencies: [ - "OSSSpeechKit" - ], - path: "Example/Tests", - exclude: [ - "Info.plist" - ], - linkerSettings: [ - .linkedFramework("AVKit") - ] - )], - swiftLanguageVersions: [.v5] + .testTarget( + name: "OSSSpeechKitTests", + dependencies: ["OSSSpeechKit"], + path: "Example/Tests", + exclude: ["Info.plist", "RecordingSessionModelTests.swift"], + resources: [ + .process("LocalizableTests.strings") + ], + linkerSettings: [ + .linkedFramework("AVFoundation"), + .linkedFramework("Speech"), + .linkedFramework("UIKit") + ] + ) + ], + swiftLanguageModes: [.v5] ) diff --git a/README.md b/README.md index 6e79f8b..f001698 100644 --- a/README.md +++ b/README.md @@ -1,252 +1,199 @@ # OSSSpeechKit -[![OSSSpeechKit Logo](https://appdevguy.github.io/OSSSpeechKit/OSSSpeechKit-Logo.png)](https://github.com/AppDevGuy/OSSSpeechKit) +OSSSpeechKit is an iOS library for speech synthesis and speech recognition built on Apple's `AVFoundation` and `Speech` frameworks. -[![Build Status](https://travis-ci.org/AppDevGuy/OSSSpeechKit.svg?branch=master)](https://travis-ci.org/AppDevGuy/OSSSpeechKit) -[![Version](https://img.shields.io/cocoapods/v/OSSSpeechKit.svg?style=flat)](https://cocoapods.org/pods/OSSSpeechKit) -[![License](https://img.shields.io/cocoapods/l/OSSSpeechKit.svg?style=flat)](https://cocoapods.org/pods/OSSSpeechKit) -[![Platform](https://img.shields.io/cocoapods/p/OSSSpeechKit.svg?style=flat)](https://cocoapods.org/pods/OSSSpeechKit) -[![codecov](https://codecov.io/gh/AppDevGuy/OSSSpeechKit/branch/master/graph/badge.svg)](https://codecov.io/gh/AppDevGuy/OSSSpeechKit) -[![docs](https://appdevguy.github.io/OSSSpeechKit/badge.svg)](https://appdevguy.github.io/OSSSpeechKit) +## Requirements -OSSSpeechKit was developed to provide easier accessibility options to apps. +- iOS 17 or later +- Swift 5 language mode or later +- Xcode with Swift 6 package support -Apple does not make it easy to get the right voice, nor do they provide a simple way of selecting a language or using speech to text. OSSSpeechKit makes the hassle of trying to find the right language go away. +## Installation -# Requirements +In Xcode, choose **File > Add Package Dependencies**, enter: -- Swift 5.0 or higher -- iOS 13.0 or higher -- Cocoapods - -# Supported Languages - -The table below shows the original 37 languages first supported. Since v0.3.3, an additional 10 languages have been added. - -
English - Australian
🇦🇺 		Hebrew
🇮🇱 		Japanese
🇯🇵 		Romanian
🇷🇴 		Swedish
🇸🇪 		Norsk
🇳🇴
Portuguese - Brazilian
🇧🇷 		Hindi - Indian
🇮🇳 		Korean
🇰🇷 		Russian
🇷🇺 		Chinese - Taiwanese
🇹🇼 		Dutch - Belgium
🇧🇪
French - Canadian
🇨🇦 		Hungarian
🇭🇺 		Spanish - Mexican
🇲🇽 		Arabic - Saudi Arabian
🇸🇦 		Thai
🇹🇭 		French
🇫🇷
Chinese
🇨🇳 		Indonesian
🇮🇩 		Norwegian
🇳🇴 		Slovakian
🇸🇰 		Turkish
🇹🇷 		Finnish
🇫🇮
Chinese - Hong Kong
🇭🇰 		English - Irish
🇮🇪 		Polish
🇵🇱 		English - South African
🇿🇦 		English - United States
🇺🇸 		Danish
🇩🇰
Czech
🇨🇿 		Italian
🇮🇹 		Portuguese
🇵🇹 		Spanish
🇪🇸 		English
🇬🇧		 Dutch
🇳🇱
Greek
🇬🇷
- -# Features - -OSSSpeechKit offers simple **text to speech** and **speech to text** in 47 different languages. - -OSSSpeechKit is built on top of both the [AVFoundation](https://developer.apple.com/documentation/avfoundation) and [Speech](https://developer.apple.com/documentation/speech) frameworks. - -You can achieve text to speech or speech to text in as little as two lines of code. - -The speech will play over the top of other sounds such as music. - -# Installation - -OSSSpeechKit is available through [CocoaPods](https://cocoapods.org). To install it, simply add the following line to your Podfile: - -```ruby -pod 'OSSSpeechKit' +```text +https://github.com/AppDevGuy/OSSSpeechKit.git ``` -# Implementation - -## Text to Speech - -These methods enable you to pass in a string and hear the text played back using. +Select version `1.0.0` or later and add the `OSSSpeechKit` library product to your app target. -### Simple +You can also add it to `Package.swift`: ```swift -import OSSSpeechKit +dependencies: [ + .package( + url: "https://github.com/AppDevGuy/OSSSpeechKit.git", + from: "1.0.0" + ) +] +``` -..... +Swift Package Manager is the only supported installation method. The historical CocoaPods release `0.3.3` remains available for existing builds but is no longer maintained; version 1.0 and later are not published to CocoaPods. -// Declare an instance of OSSSpeechKit -let speechKit = OSSSpeech.shared -// Set the voice you wish to use - currently upper case for formality or language and country name -speechKit.voice = OSSVoice(quality: .enhanced, language: .Australian) -// Set the text in the language you have set -speechKit.speakText(text: "Hello, my name is OSSSpeechKit.") -``` +## Speech synthesis -### Advanced +`OSSSpeechEngine` is main-actor isolated and instance based. Select a language from the catalog, confirm that a voice exists on the current device, then speak: ```swift +import AVFoundation import OSSSpeechKit -..... - -// Declare an instance of OSSSpeechKit -let speechKit = OSSSpeech.shared -// Create a voice instance -let newVoice = OSSVoice() -// Set the language -newVoice.language = OSSVoiceEnum.Australian.rawValue -// Set the voice quality -newVoice.quality = .enhanced -// Set the voice of the speech kit -speechKit.voice = newVoice -// Initialise an utterance -let utterance = OSSUtterance(string: "Testing") -// Set the recognition task type -speechKit.recognitionTaskType = .dictation -// Set volume -utterance.volume = 0.5 -// Set rate of speech -utterance.rate = 0.5 -// Set the pitch -utterance.pitchMultiplier = 1.2 -// Set speech utterance -speechKit.utterance = utterance -// Ask to speak -speechKit.speakText(text: utterance.speechString) -``` - -## Speech to Text - -Currently speech to text is offered in a very simple format. Starting and stopping of recording is handled by the app. - -### iOS 13 On-Device Speech to Text support is now available as of 0.3.0 🎉 +let engine = OSSSpeechEngine() +let language = OSSLanguage.catalog.first { + $0.id == "english-australia" +}! -SpeechKit implements delegates to handle the recording authorization, output of text and failure to record. +guard !language.availableSynthesisVoices.isEmpty else { + // Ask the user to install a compatible system voice. + return +} -```swift -speechKit.delegate = self -// Call to start and end recording. -speechKit.recordVoice() -// Call to end recording -speechKit.endVoiceRecording() +try await engine.speak( + "Hello from OSSSpeechKit.", + voice: OSSVoiceConfiguration( + language: language, + preferredQuality: .enhanced + ), + configuration: OSSUtteranceConfiguration( + rate: AVSpeechUtteranceDefaultSpeechRate, + pitchMultiplier: 1, + volume: 1 + ) +) ``` -It is important that you have included in your `info.plist` the following: - -> Privacy - Speech Recognition Usage Description - -> Privacy - Microphone Usage Description - -Without these, you will not be able to access the microphone nor speech recognition. - -### Delegates +Use `pauseSpeaking()`, `continueSpeaking()`, and `stopSpeaking()` to control playback. -Handle returning authentication status to user - primary use is for non-authorized state. +## Speech recognition -> `func authorizationToMicrophone(withAuthentication type: OSSSpeechKitAuthorizationStatus)` +Add both usage descriptions to the consuming app's `Info.plist`: -When the microphone has finished accepting audio, this delegate will be called with the final best text output. - -> `func didFailToCommenceSpeechRecording()` - -If the speech recogniser and request fail to set up, this method will be called. - -> `func didFinishListening(withText text: String)` - -For further information you can [check out the Apple documentation directly.](https://developer.apple.com/documentation/speech/sfspeechrecognizer) - -# Other Features - -### List all available voices: - -```swift -let allLanguages = OSSVoiceEnum.allCases +```xml +NSMicrophoneUsageDescription +Explain why your app records audio. +NSSpeechRecognitionUsageDescription +Explain why your app transcribes speech. ``` -### Get specific voice information: +Then consume recognition events: ```swift -// All support languages -let allVoices = OSSVoiceEnum.allCases -// Language details -let languageInformation = allVoices[0].getDetails() -// Flag of country -let flag = allVoices[0].flag +let engine = OSSSpeechEngine() + +do { + let events = try await engine.recognitionEvents( + locale: Locale(identifier: "en-AU") + ) + + for try await event in events { + switch event { + case .partial(let text): + print("Partial:", text) + case .completed(let text): + print("Final:", text) + case .availabilityChanged(let available): + print("Available:", available) + case .cancelled: + break + } + } +} catch { + print("Recognition failed:", error) +} ``` -The `getDetails()` method returns a struct containing: +Call `cancelRecognition()` to stop an active session. Set `usesOnDeviceRecognition = true` before starting if your product requires on-device recognition; the operation fails when the selected recognizer does not support it. + +For a dictation-style session that stays open across verbal pauses, consume the +continuous event stream: ```swift -OSSVoiceInfo { - /// The name of the voice; All AVSpeechSynthesisVoice instances have a persons name. - var name: String? - /// The name of the language being used. - var language: String? - /// The language code is what is internationally used in Locale settings. - var languageCode: String? - /// Identifier is a unique bundle url provided by Apple for each AVSpeechSynthesisVoice. - var identifier: Any? +let events = try await engine.continuousRecognitionEvents( + locale: Locale(identifier: "en-AU") +) + +for try await event in events { + switch event { + case .transcript(let transcript): + print(transcript.formattedText) + for segment in transcript.segments { + print(segment.timestamp, segment.duration, segment.text) + } + case .paused: + print("Capture paused") + case .resumed: + print("Capture resumed") + case .completed, .cancelled: + break + case .availabilityChanged(let available): + print("Available:", available) + } } ``` -### Other Info - -The `OSSVoiceEnum` contains other methods, such as a hello message, title variable and subtitle variable so you can use it in a list. - -You can also set the speech: - -- volume -- pitchMultiplier -- rate +Use `pauseRecognition()` and `resumeRecognition()` to suspend and restart +microphone capture while retaining the same event stream. Call +`finishRecognition()` to end successfully, or `cancelRecognition()` to cancel. +Segment timestamps use active recording time, so time spent paused is excluded. +The API transcribes live microphone input; it does not save an audio file. -As well as using an `NSAttributedString`. +## Languages, voices, and flags -There are plans to implement flags for each country as well as some more features, such as being able to play the voice if the device is on silent. +`OSSLanguage.catalog` is display metadata, not a guarantee of runtime support. Availability varies by OS release, device, installed voice assets, region, network access, and Apple's services. -If the language or voice you require is not available, this is either due to: +The catalog was reconciled against Apple's current +[VoiceOver language support](https://support.apple.com/en-us/111748) and +[feature availability](https://www.apple.com/ios/feature-availability/) pages. +Exact synthesis voices come from +[`AVSpeechSynthesisVoice.speechVoices()`](https://developer.apple.com/documentation/avfaudio/avspeechsynthesisvoice/speechvoices()) +and recognition locales come from +[`SFSpeechRecognizer.supportedLocales()`](https://developer.apple.com/documentation/speech/sfspeechrecognizer/supportedlocales()); +those runtime results are authoritative. -- Apple have not made it available through their AVFoundation; -- or the SDK has not been updated to include the newly added voice. - -# Important Information - -Apple do not make the voice of Siri available for use. - -This kit provides Apple's AVFoundation voices available and easy to use, so you do not need to know all the voice codes, among many other things. - -To say things correctly in each language, you need to set the voice to the correct language and supply that languages text; this SDK is not a translator. - -### Code Example: - -You wish for you app to use a Chinese voice, you will need to ensure the text being passed in is Chinese. - -_Disclaimer: I do not know how to speak Chinese, I have used Google translate for the Chinese characters._ - -#### Correct: - -```swift -speechKit.voice = OSSVoice(quality: .enhanced, language: .Chinese) -speechKit.speakText(text: "你好我的名字是 ...") -``` - -#### Incorrect: +Check capabilities when presenting an option: ```swift -speechKit.voice = OSSVoice(quality: .enhanced, language: .Australian) -speechKit.speakText(text: "你好我的名字是 ...") +for language in OSSLanguage.catalog { + let canSpeak = !language.availableSynthesisVoices.isEmpty + let canRecognize = language.supportsRecognition + let flag = language.flagEmoji + print(flag, language.name, canSpeak, canRecognize) +} ``` -OR +For UIKit code that needs an image, use: ```swift -speechKit.voice = OSSVoice(quality: .enhanced, language: .Chinese) -speechKit.speakText(text: "Hello, my name is ...") +let image = language.renderedFlagImage(pointSize: 24) ``` -This same principle applies to all other languages such as German, Saudi Arabian, French, etc.. Failing to set the language for the text you wish to be spoken will not sound correct. +Speech synthesis is not translation. Supply text written for the selected language and locale. -# Contributions and Queries +## Privacy -If you have a question, please create a ticket or email me directly. +OSSSpeechKit requests microphone and speech-recognition permission only when your app asks it to. Your app is responsible for clear `NSMicrophoneUsageDescription` and `NSSpeechRecognitionUsageDescription` strings and for disclosing its own data practices. -If you wish to contribute, please create a pull request. +Speech recognition may use Apple services unless on-device recognition is requested and supported. Review Apple's current Speech framework and App Store privacy requirements for your use case. -# Example Project +The included `PrivacyInfo.xcprivacy` declares that OSSSpeechKit itself does not track users, collect data, or access a required-reason API. It does not replace the consuming app's privacy manifest or App Privacy answers. -To run the example project, clone the repo, and run `pod install` from the Example directory first. +## Migrating from pre-1.0 -# Unit Tests +The singleton and subclass-based APIs remain temporarily available but are deprecated: -For further examples, please look at the Unit Test class. +- `OSSSpeech.shared` → create an `OSSSpeechEngine` +- `OSSVoice` → `OSSVoiceConfiguration` +- `OSSUtterance` → `OSSUtteranceConfiguration` +- `OSSVoiceEnum.flag` → `flagEmoji` or `renderedFlagImage(pointSize:scale:)` +- `OSSVoiceEnum` catalogs → `OSSLanguage.catalog` -# Author +See [MIGRATION.md](MIGRATION.md) for examples and behavior changes. -App Dev Guy +## Example and tests -profile for App Dev Guy at Stack Overflow, Q&A for professional and enthusiast programmers +Open `Example/OSSSpeechKit.xcodeproj` to run the example app and its tests. The project links the package from the repository root. -# License +## License -OSSSpeechKit is available under the MIT license. See the LICENSE file for more info. +OSSSpeechKit is available under the MIT license. See [LICENSE](LICENSE). diff --git a/_Pods.xcodeproj b/_Pods.xcodeproj deleted file mode 120000 index 3c5a8e7..0000000 --- a/_Pods.xcodeproj +++ /dev/null @@ -1 +0,0 @@ -Example/Pods/Pods.xcodeproj \ No newline at end of file diff --git a/docs/Classes.html b/docs/Classes.html index c1f50c0..b1f9c19 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -8,20 +8,28 @@ + + +
-

OSSSpeechKit 0.3.0 Docs (95% documented)

-

View on GitHub

+

OSSSpeechKit 1.0.0 Docs (100% documented)

+

GitHubView on GitHub

+
+
+ +
+
@@ -34,6 +42,12 @@
  • OSSSpeech
    • +
  • + OSSSpeechEngine +
    • +
  • + – State +
  • OSSSpeechUtility
    • @@ -48,12 +62,18 @@
  • Enumerations
      +
    • + OSSSpeechError +
    • OSSSpeechKitAuthorizationStatus
    • OSSSpeechKitErrorType
      • +
    • + OSSSpeechRecognitionEvent +
    • OSSSpeechRecognitionTaskType
      • @@ -65,9 +85,6 @@
    • Extensions
        -
      • - Bundle -
      • NSObject
        • @@ -84,6 +101,15 @@
      • Structures
          +
        • + OSSLanguage +
          • +
        • + OSSUtteranceConfiguration +
          • +
        • + OSSVoiceConfiguration +
        • OSSVoiceInfo
          • @@ -122,7 +148,8 @@

          Classes

          Declaration

          Swift

          - 
          public class OSSSpeech : NSObject
          + 
          @available(*, deprecated, message: "Use the instance-based OSSSpeechEngine async API.")
+public class OSSSpeech : NSObject, @unchecked Sendable
          extension OSSSpeech: SFSpeechRecognitionTaskDelegate, SFSpeechRecognizerDelegate
          @@ -130,6 +157,36 @@

          Declaration

          +
        • +
          + + + + OSSSpeechEngine + +
          +
          +
          +
          +
          +
          +

          Instance-based, main-actor-isolated speech synthesis and recognition engine.

          + + See more +
          +
          +

          Declaration

          +
          +

          Swift

          + 
          @MainActor
+public final class OSSSpeechEngine : NSObject
          +
          extension OSSSpeechEngine: AVSpeechSynthesizerDelegate, SFSpeechRecognizerDelegate
          + +
          +
          +
          +
          +
        • @@ -143,7 +200,7 @@

          Declaration

          -

          Undocumented

          +

          Utility methods for localized strings and diagnostics used by OSSSpeechKit.

          See more
          @@ -183,7 +240,8 @@

          Declaration

          Declaration

          Swift

          - 
          public class OSSUtterance : AVSpeechUtterance
          + 
          @available(*, deprecated, message: "Use OSSUtteranceConfiguration with OSSSpeechEngine.")
+public class OSSUtterance : AVSpeechUtterance
          @@ -220,8 +278,8 @@

          Declaration

          Declaration

          Swift

          - 
          @available(iOS 9.0, *)
-public class OSSVoice : AVSpeechSynthesisVoice
          + 
          @available(*, deprecated, message: "Use OSSVoiceConfiguration, which resolves a real AVSpeechSynthesisVoice.")
+public class OSSVoice : AVSpeechSynthesisVoice, @unchecked Sendable
          @@ -233,11 +291,10 @@

          Declaration

          - diff --git a/docs/Classes/OSSSpeech.html b/docs/Classes/OSSSpeech.html index 9bb94ab..f5bcf08 100644 --- a/docs/Classes/OSSSpeech.html +++ b/docs/Classes/OSSSpeech.html @@ -8,20 +8,28 @@ + + +
          -

          OSSSpeechKit 0.3.0 Docs (95% documented)

          -

          View on GitHub

          +

          OSSSpeechKit 1.0.0 Docs (100% documented)

          +

          GitHubView on GitHub

          +
          +
          + +
          +
          @@ -34,6 +42,12 @@
        • OSSSpeech
          • +
        • + OSSSpeechEngine +
          • +
        • + – State +
        • OSSSpeechUtility
          • @@ -48,12 +62,18 @@
        • Enumerations
            +
          • + OSSSpeechError +
          • OSSSpeechKitAuthorizationStatus
          • OSSSpeechKitErrorType
            • +
          • + OSSSpeechRecognitionEvent +
          • OSSSpeechRecognitionTaskType
            • @@ -65,9 +85,6 @@
          • Extensions
              -
            • - Bundle -
            • NSObject
              • @@ -84,6 +101,15 @@
            • Structures
                +
              • + OSSLanguage +
                • +
              • + OSSUtteranceConfiguration +
                • +
              • + OSSVoiceConfiguration +
              • OSSVoiceInfo
                • @@ -97,7 +123,9 @@

                OSSSpeech

                - 
                public class OSSSpeech : NSObject
                + + 
                @available(*, deprecated, message: "Use the instance-based OSSSpeechEngine async API.")
+public class OSSSpeech : NSObject, @unchecked Sendable
                extension OSSSpeech: SFSpeechRecognitionTaskDelegate, SFSpeechRecognizerDelegate
                @@ -112,7 +140,7 @@

                OSSSpeech

                -

                Variables

                +

                Variables

                @@ -308,7 +336,8 @@

                Declaration

                Declaration

                Swift

                - 
                public var srp: SFSpeechRecognizer.Type
                + 
                @available(*, deprecated, message: "Use dependency injection with OSSSpeechEngine tests.")
+public var srp: SFSpeechRecognizer.Type
                @@ -323,11 +352,40 @@

                Declaration

                -

                Lifecycle

                +

                Lifecycle

                  +
                • + +
                  +
                  +
                  +
                  +
                  +

                  Allow injection of the AVSpeechSynthesizer so that caller can be AVSpeechSynthesizerDelegate + func speechSynthesizer(_ synthesizer: AVSpeechSynthesizer, willSpeakRangeOfSpeechString characterRange: NSRange, utterance: AVSpeechUtterance) { + func speechSynthesizer(_ synthesizer: AVSpeechSynthesizer, didFinish utterance: AVSpeechUtterance) {

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public init(speechSynthesizer: AVSpeechSynthesizer = AVSpeechSynthesizer())
                  + +
                  +
                  +
                  +
                  +
                • @@ -348,7 +406,8 @@

                  Lifecycle

                  Declaration

                  Swift

                  - 
                  public class var shared: OSSSpeech { get }
                  + 
                  @available(*, deprecated, message: "Create an OSSSpeechEngine instance instead.")
+public class var shared: OSSSpeech { get }
                  @@ -363,7 +422,7 @@

                  Declaration

                  -

                  Public Methods

                  +

                  Public Methods

                  @@ -462,25 +521,12 @@

                  Parameters

                  • -
                - -
                -
                - - -
                - -

                Public Voice Recording Methods

                -

                -
                -
                -
                • @@ -488,18 +534,45 @@

                  Public Voice Recording Methods

                  -

                  Record and recognise speech

                  +

                  Pause speaking text

                  -

                  This method will check to see if user is authorised to record. If they are, the recording will proceed.

                  +

                  Will check if the current speech synthesizer session is speaking before attempting to pause.

                  -

                  Upon checking the authorisation and being registered successful, a check to determine if a recording session is active will be made and any active session will be cancelled.

                  +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func pauseSpeaking()
                  + +
                  +
                  +
                  +

                  +
                  • +
                • +
                  + + + + continueSpeaking() + +
                  +
                  +
                  +
                  +
                  +
                  +

                  Continue speaking text

                  + +

                  Will check if the current speech synthesizer session is paused before attempting to continue speaking.

                  Declaration

                  Swift

                  - 
                  public func recordVoice(requestMicPermission requested: Bool = true)
                  + 
                  public func continueSpeaking()
                  @@ -509,9 +582,9 @@

                  Declaration

                • @@ -519,14 +592,17 @@

                  Declaration

                  -

                  End recording of speech session if one exists.

                  +

                  Force the ending of speaking.

                  + +

                  Does not remove or reset the utterance or voice - only stops the current speaking if it’s active. +Also checks to see if the current synthesizer session is paused.

                  Declaration

                  Swift

                  - 
                  public func endVoiceRecording()
                  + 
                  public func stopSpeaking()
                  @@ -537,11 +613,11 @@

                  Declaration

                  - - + +
                  - -

                  Private Voice Recording

                  + +

                  Public Voice Recording Methods

                  @@ -549,9 +625,40 @@

                  Private Voice Recording

                • +
                  +
                  +
                  +
                  +
                  +

                  Record and recognise speech

                  + +

                  This method will check to see if user is authorised to record. If they are, the recording will proceed.

                  + +

                  Upon checking the authorisation and being registered successful, a check to determine if a recording session is active will be made and any active session will be cancelled.

                  + +
                  +
                  +

                  Declaration

                  +
                  +

                  Swift

                  + 
                  public func recordVoice(requestMicPermission requested: Bool = true)
                  + +
                  +
                  +
                  +
                  +
                  • +
                • +
                  @@ -559,14 +666,14 @@

                  Private Voice Recording

                  -

                  Undocumented

                  +

                  End recording of speech session if one exists.

                  Declaration

                  Swift

                  - 
                  func engineSetup(_ engine: AVAudioEngine) -> Bool
                  + 
                  public func endVoiceRecording()
                  @@ -581,7 +688,7 @@

                  Declaration

                  -

                  SFSpeechRecognitionTaskDelegate Methods

                  +

                  SFSpeechRecognitionTaskDelegate Methods

                  @@ -680,7 +787,7 @@

                  Declaration

                  -

                  Undocumented

                  +

                  Called when the recognizer detects speech in the audio stream.

                  @@ -707,7 +814,7 @@

                  Declaration

                  -

                  Undocumented

                  +

                  Called when the recognizer has finished reading audio from the request.

                  @@ -729,7 +836,7 @@

                  Declaration

                  -

                  SFSpeechRecognizerDelegate Methods

                  +

                  SFSpeechRecognizerDelegate Methods

                  @@ -766,11 +873,10 @@

                  Declaration

                  • -
                  • diff --git a/docs/Classes/OSSSpeechEngine.html b/docs/Classes/OSSSpeechEngine.html new file mode 100644 index 0000000..5030a3c --- /dev/null +++ b/docs/Classes/OSSSpeechEngine.html @@ -0,0 +1,687 @@ + + + + OSSSpeechEngine Class Reference + + + + + + + + + + + + + +
                  +
                  +

                  OSSSpeechKit 1.0.0 Docs (100% documented)

                  +

                  GitHubView on GitHub

                  +
                  +
                  + +
                  +
                  +
                  +
                  +
                  + +
                  +
                  + +
                  +
                  +
                  +

                  OSSSpeechEngine

                  +
                  +
                  + + 
                  @MainActor
+public final class OSSSpeechEngine : NSObject
                  +
                  extension OSSSpeechEngine: AVSpeechSynthesizerDelegate, SFSpeechRecognizerDelegate
                  + +
                  +
                  +

                  Instance-based, main-actor-isolated speech synthesis and recognition engine.

                  + +
                  +
                  +
                  +
                    +
                  • +
                    + + + + State + +
                    +
                    +
                    +
                    +
                    +
                    +

                    Current high-level activity of the speech engine.

                    + + See more +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    public enum State : Equatable
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + state + +
                    +
                    +
                    +
                    +
                    +
                    +

                    Current high-level activity of the engine.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public private(set) var state: State { get }
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • + +
                    +
                    +
                    +
                    +
                    +

                    Whether recognition should require on-device processing when supported.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public var usesOnDeviceRecognition: Bool
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + recognitionTaskHint + +
                    +
                    +
                    +
                    +
                    +
                    +

                    Task hint passed to the underlying speech recognizer.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public var recognitionTaskHint: SFSpeechRecognitionTaskHint
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + init() + +
                    +
                    +
                    +
                    +
                    +
                    +

                    Creates a speech engine with its own synthesizer, audio engine, and audio session.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public override init()
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • + +
                    +
                    +
                    +
                    +
                    +

                    Locales that the platform reports as available for speech recognition.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public static var supportedRecognitionLocales: Set<Locale> { get }
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + requestSpeechAuthorization() + + + Asynchronous + +
                    +
                    +
                    +
                    +
                    +
                    +

                    Requests speech recognition authorization and maps the native status.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public func requestSpeechAuthorization() async -> OSSSpeechKitAuthorizationStatus
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + requestMicrophoneAuthorization() + + + Asynchronous + +
                    +
                    +
                    +
                    +
                    +
                    +

                    Requests microphone recording authorization.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public func requestMicrophoneAuthorization() async -> Bool
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + speak(_:voice:configuration:) + + + Asynchronous + +
                    +
                    +
                    +
                    +
                    +
                    +

                    Speaks plain text using a resolved AVFoundation voice.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public func speak(
+    _ text: String,
+    voice: OSSVoiceConfiguration,
+    configuration: OSSUtteranceConfiguration = .init()
+) async throws
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + speak(_:voice:configuration:) + + + Asynchronous + +
                    +
                    +
                    +
                    +
                    +
                    +

                    Speaks attributed text using a resolved AVFoundation voice.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public func speak(
+    _ attributedText: NSAttributedString,
+    voice: OSSVoiceConfiguration,
+    configuration: OSSUtteranceConfiguration = .init()
+) async throws
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + pauseSpeaking() + +
                    +
                    +
                    +
                    +
                    +
                    +

                    Pauses the current utterance immediately when the engine is speaking.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public func pauseSpeaking()
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + continueSpeaking() + +
                    +
                    +
                    +
                    +
                    +
                    +

                    Resumes a paused utterance.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public func continueSpeaking()
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + stopSpeaking() + +
                    +
                    +
                    +
                    +
                    +
                    +

                    Stops the current utterance and finishes the synthesis operation.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public func stopSpeaking()
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + recognitionEvents(locale:requestAuthorization:) + + + Asynchronous + +
                    +
                    +
                    +
                    +
                    +
                    +

                    Starts recognition and returns a stream that owns the recording session. +Cancelling iteration tears down the audio tap and recognition task.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public func recognitionEvents(
+    locale: Locale,
+    requestAuthorization: Bool = true
+) async throws -> AsyncThrowingStream<OSSSpeechRecognitionEvent, Error>
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + cancelRecognition() + +
                    +
                    +
                    +
                    +
                    +
                    +

                    Cancels the active recognition session and tears down audio recording.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    @MainActor
+public func cancelRecognition()
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • + +
                    +
                    +
                    +
                    +
                    +

                    Completes the awaiting synthesis operation when AVFoundation finishes speaking.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    nonisolated public func speechSynthesizer(
+    _ synthesizer: AVSpeechSynthesizer,
+    didFinish utterance: AVSpeechUtterance
+)
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • + +
                    +
                    +
                    +
                    +
                    +

                    Completes the awaiting synthesis operation with cancellation when speech is cancelled.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    nonisolated public func speechSynthesizer(
+    _ synthesizer: AVSpeechSynthesizer,
+    didCancel utterance: AVSpeechUtterance
+)
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • + +
                    +
                    +
                    +
                    +
                    +

                    Emits recognizer availability changes to the active recognition stream.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    nonisolated public func speechRecognizer(
+    _ speechRecognizer: SFSpeechRecognizer,
+    availabilityDidChange available: Bool
+)
                    + +
                    +
                    +
                    +
                    +
                    • +
                  +
                  +
                  +
                  + +
                  +
                  + + diff --git a/docs/Classes/OSSSpeechEngine/State.html b/docs/Classes/OSSSpeechEngine/State.html new file mode 100644 index 0000000..a66b73d --- /dev/null +++ b/docs/Classes/OSSSpeechEngine/State.html @@ -0,0 +1,229 @@ + + + + State Enumeration Reference + + + + + + + + + + + + + +
                  +
                  +

                  OSSSpeechKit 1.0.0 Docs (100% documented)

                  +

                  GitHubView on GitHub

                  +
                  +
                  + +
                  +
                  +
                  +
                  +
                  + +
                  +
                  + +
                  +
                  +
                  +

                  State

                  +
                  +
                  + + 
                  public enum State : Equatable
                  + +
                  +
                  +

                  Current high-level activity of the speech engine.

                  + +
                  +
                  +
                  +
                    +
                  • +
                    + + + + idle + +
                    +
                    +
                    +
                    +
                    +
                    +

                    The engine is not speaking or listening.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    case idle
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + speaking + +
                    +
                    +
                    +
                    +
                    +
                    +

                    The engine is currently synthesizing speech.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    case speaking
                    + +
                    +
                    +
                    +
                    +
                    • +
                  • +
                    + + + + listening + +
                    +
                    +
                    +
                    +
                    +
                    +

                    The engine is currently recording and recognizing speech.

                    + +
                    +
                    +

                    Declaration

                    +
                    +

                    Swift

                    + 
                    case listening
                    + +
                    +
                    +
                    +
                    +
                    • +
                  +
                  +
                  +
                  + +
                  +
                  + + diff --git a/docs/Classes/OSSSpeechUtility.html b/docs/Classes/OSSSpeechUtility.html index 06956c8..a5e5b1e 100644 --- a/docs/Classes/OSSSpeechUtility.html +++ b/docs/Classes/OSSSpeechUtility.html @@ -8,20 +8,28 @@ + + +
                  -

                  OSSSpeechKit 0.3.0 Docs (95% documented)

                  -

                  View on GitHub

                  +

                  OSSSpeechKit 1.0.0 Docs (100% documented)

                  +

                  GitHubView on GitHub

                  +
                  +
                  + +
                  +
                  @@ -34,6 +42,12 @@
                • OSSSpeech
                  • +
                • + OSSSpeechEngine +
                  • +
                • + – State +
                • OSSSpeechUtility
                  • @@ -48,12 +62,18 @@
                • Enumerations
                @@ -151,7 +178,7 @@

                Declaration

                -

                Public Methods

                +

                Public Methods

                @@ -227,11 +254,10 @@

                Return Value

                - diff --git a/docs/Classes/OSSUtterance.html b/docs/Classes/OSSUtterance.html index 5d1a0f4..c6e4f64 100644 --- a/docs/Classes/OSSUtterance.html +++ b/docs/Classes/OSSUtterance.html @@ -8,20 +8,28 @@ + + +
                -

                OSSSpeechKit 0.3.0 Docs (95% documented)

                -

                View on GitHub

                +

                OSSSpeechKit 1.0.0 Docs (100% documented)

                +

                GitHubView on GitHub

                +
                +
                + +
                +
                @@ -34,6 +42,12 @@
              • OSSSpeech
                • +
              • + OSSSpeechEngine +
                • +
              • + – State +
              • OSSSpeechUtility
                • @@ -48,12 +62,18 @@
              • Enumerations
                  +
                • + OSSSpeechError +
                • OSSSpeechKitAuthorizationStatus
                • OSSSpeechKitErrorType
                  • +
                • + OSSSpeechRecognitionEvent +
                • OSSSpeechRecognitionTaskType
                  • @@ -65,9 +85,6 @@
                • Extensions
                    -
                  • - Bundle -
                  • NSObject
                    • @@ -84,6 +101,15 @@
                  • Structures
                      +
                    • + OSSLanguage +
                      • +
                    • + OSSUtteranceConfiguration +
                      • +
                    • + OSSVoiceConfiguration +
                    • OSSVoiceInfo
                      • @@ -97,7 +123,9 @@

                      OSSUtterance

                      - 
                      public class OSSUtterance : AVSpeechUtterance
                      + + 
                      @available(*, deprecated, message: "Use OSSUtteranceConfiguration with OSSSpeechEngine.")
+public class OSSUtterance : AVSpeechUtterance
                      @@ -115,7 +143,7 @@

                      OSSUtterance

                      -

                      Variables

                      +

                      Variables

                      @@ -188,7 +216,7 @@

                      Declaration

                      -

                      Lifecycle

                      +

                      Lifecycle

                      @@ -206,7 +234,10 @@

                      Lifecycle

                      -

                      Undocumented

                      +

                      Creates an error placeholder utterance.

                      + +

                      Use init(string:) or init(attributedString:) to create a useful +utterance.

                      @@ -306,11 +337,10 @@

                      Declaration

                      - diff --git a/docs/Classes/OSSVoice.html b/docs/Classes/OSSVoice.html index ab77adc..7430319 100644 --- a/docs/Classes/OSSVoice.html +++ b/docs/Classes/OSSVoice.html @@ -8,20 +8,28 @@ + + +
                      -

                      OSSSpeechKit 0.3.0 Docs (95% documented)

                      -

                      View on GitHub

                      +

                      OSSSpeechKit 1.0.0 Docs (100% documented)

                      +

                      GitHubView on GitHub

                      +
                      +
                      + +
                      +
                      @@ -34,6 +42,12 @@
                    • OSSSpeech
                      • +
                    • + OSSSpeechEngine +
                      • +
                    • + – State +
                    • OSSSpeechUtility
                      • @@ -48,12 +62,18 @@
                    • Enumerations
                        +
                      • + OSSSpeechError +
                      • OSSSpeechKitAuthorizationStatus
                      • OSSSpeechKitErrorType
                        • +
                      • + OSSSpeechRecognitionEvent +
                      • OSSSpeechRecognitionTaskType
                        • @@ -65,9 +85,6 @@
                      • Extensions
                          -
                        • - Bundle -
                        • NSObject
                          • @@ -84,6 +101,15 @@
                        • Structures
                            +
                          • + OSSLanguage +
                            • +
                          • + OSSUtteranceConfiguration +
                            • +
                          • + OSSVoiceConfiguration +
                          • OSSVoiceInfo
                            • @@ -97,8 +123,9 @@

                            OSSVoice

                            - 
                            @available(iOS 9.0, *)
-public class OSSVoice : AVSpeechSynthesisVoice
                            + + 
                            @available(*, deprecated, message: "Use OSSVoiceConfiguration, which resolves a real AVSpeechSynthesisVoice.")
+public class OSSVoice : AVSpeechSynthesisVoice, @unchecked Sendable
                            @@ -121,7 +148,7 @@

                            OSSVoice

                            -

                            Private Properties

                            +

                            Private Properties

                            @@ -299,11 +326,10 @@

                            Declaration

                            - diff --git a/docs/Enums.html b/docs/Enums.html index aa240fd..8fabd61 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -8,20 +8,28 @@ + + +
                            -

                            OSSSpeechKit 0.3.0 Docs (95% documented)

                            -

                            View on GitHub

                            +

                            OSSSpeechKit 1.0.0 Docs (100% documented)

                            +

                            GitHubView on GitHub

                            +
                            +
                            + +
                            +
                            @@ -34,6 +42,12 @@
                          • OSSSpeech
                            • +
                          • + OSSSpeechEngine +
                            • +
                          • + – State +
                          • OSSSpeechUtility
                            • @@ -48,12 +62,18 @@
                          • Enumerations
                              +
                            • + OSSSpeechError +
                            • OSSSpeechKitAuthorizationStatus
                            • OSSSpeechKitErrorType
                              • +
                            • + OSSSpeechRecognitionEvent +
                            • OSSSpeechRecognitionTaskType
                              • @@ -65,9 +85,6 @@
                            • Extensions
                                -
                              • - Bundle -
                              • NSObject
                                • @@ -84,6 +101,15 @@
                              • Structures
                                  +
                                • + OSSLanguage +
                                  • +
                                • + OSSUtteranceConfiguration +
                                  • +
                                • + OSSVoiceConfiguration +
                                • OSSVoiceInfo
                                  • @@ -101,6 +127,39 @@

                                  Enumerations

                                    +
                                  • +
                                    + + + + OSSVoiceEnum + +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    The available system voices.

                                    + +

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

                                    +
                                    OSSVoiceEnum.allCases
+
                                    + + See more +
                                    +
                                    +

                                    Declaration

                                    +
                                    +

                                    Swift

                                    + 
                                    @available(*, deprecated, message: "Use OSSLanguage.catalog and runtime capability APIs.")
+public enum OSSVoiceEnum : String, CaseIterable
                                    + +
                                    +
                                    +
                                    +
                                    +
                                  • @@ -188,9 +247,9 @@

                                    Declaration

                                  • @@ -198,19 +257,43 @@

                                    Declaration

                                    -

                                    The available system voices.

                                    +

                                    Typed failures emitted by the modern OSSSpeechKit API.

                                    -

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

                                    -
                                    OSSVoiceEnum.allCases
-
                                    + See more +
                                    +
                                    +

                                    Declaration

                                    +
                                    +

                                    Swift

                                    + 
                                    public enum OSSSpeechError : Error, LocalizedError
                                    - See more +
                                    +
                                    +
                                    +
                                    +
                                    • +
                                  • + +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    Events from a live recognition session.

                                    + + See more

                                    Declaration

                                    Swift

                                    - 
                                    public enum OSSVoiceEnum : String, CaseIterable
                                    + 
                                    public enum OSSSpeechRecognitionEvent
                                    @@ -222,11 +305,10 @@

                                    Declaration

                                  - diff --git a/docs/Enums/OSSSpeechError.html b/docs/Enums/OSSSpeechError.html new file mode 100644 index 0000000..3adde59 --- /dev/null +++ b/docs/Enums/OSSSpeechError.html @@ -0,0 +1,390 @@ + + + + OSSSpeechError Enumeration Reference + + + + + + + + + + + + + +
                                  +
                                  +

                                  OSSSpeechKit 1.0.0 Docs (100% documented)

                                  +

                                  GitHubView on GitHub

                                  +
                                  +
                                  + +
                                  +
                                  +
                                  +
                                  +
                                  + +
                                  +
                                  + +
                                  +
                                  +
                                  +

                                  OSSSpeechError

                                  +
                                  +
                                  + + 
                                  public enum OSSSpeechError : Error, LocalizedError
                                  + +
                                  +
                                  +

                                  Typed failures emitted by the modern OSSSpeechKit API.

                                  + +
                                  +
                                  +
                                  +
                                    +
                                  • +
                                    + + + + emptyText + +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    The provided speech text was empty or only whitespace.

                                    + +
                                    +
                                    +

                                    Declaration

                                    +
                                    +

                                    Swift

                                    + 
                                    case emptyText
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    • +
                                  • + +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    No installed speech synthesis voice matched the requested locale.

                                    + +
                                    +
                                    +

                                    Declaration

                                    +
                                    +

                                    Swift

                                    + 
                                    case voiceUnavailable(localeIdentifier: String)
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    • +
                                  • + +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    Speech recognition authorization was denied or unavailable.

                                    + +
                                    +
                                    +

                                    Declaration

                                    +
                                    +

                                    Swift

                                    + 
                                    case speechAuthorizationDenied
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    • +
                                  • + +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    Microphone recording authorization was denied or unavailable.

                                    + +
                                    +
                                    +

                                    Declaration

                                    +
                                    +

                                    Swift

                                    + 
                                    case microphoneAuthorizationDenied
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    • +
                                  • + +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    Speech recognition does not support the requested locale on this device.

                                    + +
                                    +
                                    +

                                    Declaration

                                    +
                                    +

                                    Swift

                                    + 
                                    case recognitionLocaleUnsupported(String)
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    • +
                                  • +
                                    + + + + recognizerUnavailable + +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    The speech recognizer exists but is not currently available.

                                    + +
                                    +
                                    +

                                    Declaration

                                    +
                                    +

                                    Swift

                                    + 
                                    case recognizerUnavailable
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    • +
                                  • + +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    AVFoundation could not configure or start the audio engine/session.

                                    + +
                                    +
                                    +

                                    Declaration

                                    +
                                    +

                                    Swift

                                    + 
                                    case audioEngineFailure(underlying: Error?)
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    • +
                                  • +
                                    + + + + operationInProgress + +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    +

                                    A speech synthesis or recognition operation is already active.

                                    + +
                                    +
                                    +

                                    Declaration

                                    +
                                    +

                                    Swift

                                    + 
                                    case operationInProgress
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    • +
                                  • +
                                    + + + + errorDescription + +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    + +
                                    +
                                    +

                                    Declaration

                                    +
                                    +

                                    Swift

                                    + 
                                    public var errorDescription: String? { get }
                                    + +
                                    +
                                    +
                                    +
                                    +
                                    • +
                                  +
                                  +
                                  +
                                  + +
                                  +
                                  + + diff --git a/docs/Enums/OSSSpeechKitAuthorizationStatus.html b/docs/Enums/OSSSpeechKitAuthorizationStatus.html index 5fa4339..e474088 100644 --- a/docs/Enums/OSSSpeechKitAuthorizationStatus.html +++ b/docs/Enums/OSSSpeechKitAuthorizationStatus.html @@ -8,20 +8,28 @@ + + +
                                  -

                                  OSSSpeechKit 0.3.0 Docs (95% documented)

                                  -

                                  View on GitHub

                                  +

                                  OSSSpeechKit 1.0.0 Docs (100% documented)

                                  +

                                  GitHubView on GitHub

                                  +
                                  +
                                  + +
                                  +
                                  @@ -34,6 +42,12 @@
                                • OSSSpeech
                                  • +
                                • + OSSSpeechEngine +
                                  • +
                                • + – State +
                                • OSSSpeechUtility
                                  • @@ -48,12 +62,18 @@
                                • Enumerations
                                    +
                                  • + OSSSpeechError +
                                  • OSSSpeechKitAuthorizationStatus
                                  • OSSSpeechKitErrorType
                                    • +
                                  • + OSSSpeechRecognitionEvent +
                                  • OSSSpeechRecognitionTaskType
                                    • @@ -65,9 +85,6 @@
                                  • Extensions
                                      -
                                    • - Bundle -
                                    • NSObject
                                      • @@ -84,6 +101,15 @@
                                    • Structures
                                        +
                                      • + OSSLanguage +
                                        • +
                                      • + OSSUtteranceConfiguration +
                                        • +
                                      • + OSSVoiceConfiguration +
                                      • OSSVoiceInfo
                                        • @@ -97,6 +123,7 @@

                                        OSSSpeechKitAuthorizationStatus

                                        + 
                                        public enum OSSSpeechKitAuthorizationStatus : Int
                                        @@ -247,11 +274,10 @@

                                        Declaration

                                        - diff --git a/docs/Enums/OSSSpeechKitErrorType.html b/docs/Enums/OSSSpeechKitErrorType.html index 85b8383..656d6f8 100644 --- a/docs/Enums/OSSSpeechKitErrorType.html +++ b/docs/Enums/OSSSpeechKitErrorType.html @@ -8,20 +8,28 @@ + + +
                                        -

                                        OSSSpeechKit 0.3.0 Docs (95% documented)

                                        -

                                        View on GitHub

                                        +

                                        OSSSpeechKit 1.0.0 Docs (100% documented)

                                        +

                                        GitHubView on GitHub

                                        +
                                        +
                                        + +
                                        +
                                        @@ -34,6 +42,12 @@
                                      • OSSSpeech
                                        • +
                                      • + OSSSpeechEngine +
                                        • +
                                      • + – State +
                                      • OSSSpeechUtility
                                        • @@ -48,12 +62,18 @@
                                      • Enumerations
                                          +
                                        • + OSSSpeechError +
                                        • OSSSpeechKitAuthorizationStatus
                                        • OSSSpeechKitErrorType
                                          • +
                                        • + OSSSpeechRecognitionEvent +
                                        • OSSSpeechRecognitionTaskType
                                          • @@ -65,9 +85,6 @@
                                        • Extensions
                                            -
                                          • - Bundle -
                                          • NSObject
                                            • @@ -84,6 +101,15 @@
                                          • Structures
                                              +
                                            • + OSSLanguage +
                                              • +
                                            • + OSSUtteranceConfiguration +
                                              • +
                                            • + OSSVoiceConfiguration +
                                            • OSSVoiceInfo
                                              • @@ -97,6 +123,7 @@

                                              OSSSpeechKitErrorType

                                              + 
                                              public enum OSSSpeechKitErrorType : Int
                                              @@ -386,11 +413,10 @@

                                              Declaration

                                              - diff --git a/docs/Enums/OSSSpeechRecognitionEvent.html b/docs/Enums/OSSSpeechRecognitionEvent.html new file mode 100644 index 0000000..7a5a6d2 --- /dev/null +++ b/docs/Enums/OSSSpeechRecognitionEvent.html @@ -0,0 +1,256 @@ + + + + OSSSpeechRecognitionEvent Enumeration Reference + + + + + + + + + + + + + +
                                              +
                                              +

                                              OSSSpeechKit 1.0.0 Docs (100% documented)

                                              +

                                              GitHubView on GitHub

                                              +
                                              +
                                              + +
                                              +
                                              +
                                              +
                                              +
                                              + +
                                              +
                                              + +
                                              +
                                              +
                                              +

                                              OSSSpeechRecognitionEvent

                                              +
                                              +
                                              + + 
                                              public enum OSSSpeechRecognitionEvent
                                              + +
                                              +
                                              +

                                              Events from a live recognition session.

                                              + +
                                              +
                                              +
                                              +
                                                +
                                              • +
                                                + + + + partial(_:) + +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                +

                                                Interim transcription text emitted before recognition completes.

                                                + +
                                                +
                                                +

                                                Declaration

                                                +
                                                +

                                                Swift

                                                + 
                                                case partial(String)
                                                + +
                                                +
                                                +
                                                +
                                                +
                                                • +
                                              • +
                                                + + + + completed(_:) + +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                +

                                                Final transcription text emitted when recognition completes.

                                                + +
                                                +
                                                +

                                                Declaration

                                                +
                                                +

                                                Swift

                                                + 
                                                case completed(String)
                                                + +
                                                +
                                                +
                                                +
                                                +
                                                • +
                                              • + +
                                                +
                                                +
                                                +
                                                +
                                                +

                                                Availability updates reported by the underlying speech recognizer.

                                                + +
                                                +
                                                +

                                                Declaration

                                                +
                                                +

                                                Swift

                                                + 
                                                case availabilityChanged(Bool)
                                                + +
                                                +
                                                +
                                                +
                                                +
                                                • +
                                              • +
                                                + + + + cancelled + +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                +

                                                Recognition was cancelled before producing a final result.

                                                + +
                                                +
                                                +

                                                Declaration

                                                +
                                                +

                                                Swift

                                                + 
                                                case cancelled
                                                + +
                                                +
                                                +
                                                +
                                                +
                                                • +
                                              +
                                              +
                                              +
                                              + +
                                              +
                                              + + diff --git a/docs/Enums/OSSSpeechRecognitionTaskType.html b/docs/Enums/OSSSpeechRecognitionTaskType.html index 188aa7a..6b12f60 100644 --- a/docs/Enums/OSSSpeechRecognitionTaskType.html +++ b/docs/Enums/OSSSpeechRecognitionTaskType.html @@ -8,20 +8,28 @@ + + +
                                              -

                                              OSSSpeechKit 0.3.0 Docs (95% documented)

                                              -

                                              View on GitHub

                                              +

                                              OSSSpeechKit 1.0.0 Docs (100% documented)

                                              +

                                              GitHubView on GitHub

                                              +
                                              +
                                              + +
                                              +
                                              @@ -34,6 +42,12 @@
                                            • OSSSpeech
                                              • +
                                            • + OSSSpeechEngine +
                                              • +
                                            • + – State +
                                            • OSSSpeechUtility
                                              • @@ -48,12 +62,18 @@
                                            • Enumerations
                                                +
                                              • + OSSSpeechError +
                                              • OSSSpeechKitAuthorizationStatus
                                              • OSSSpeechKitErrorType
                                                • +
                                              • + OSSSpeechRecognitionEvent +
                                              • OSSSpeechRecognitionTaskType
                                                • @@ -65,9 +85,6 @@
                                              • Extensions
                                                  -
                                                • - Bundle -
                                                • NSObject
                                                  • @@ -84,6 +101,15 @@
                                                • Structures
                                                    +
                                                  • + OSSLanguage +
                                                    • +
                                                  • + OSSUtteranceConfiguration +
                                                    • +
                                                  • + OSSVoiceConfiguration +
                                                  • OSSVoiceInfo
                                                    • @@ -97,6 +123,7 @@

                                                    OSSSpeechRecognitionTaskType

                                                    + 
                                                    public enum OSSSpeechRecognitionTaskType : Int
                                                    @@ -249,11 +276,10 @@

                                                    Declaration

                                                    - diff --git a/docs/Enums/OSSVoiceEnum.html b/docs/Enums/OSSVoiceEnum.html index 88eec06..5e3755d 100644 --- a/docs/Enums/OSSVoiceEnum.html +++ b/docs/Enums/OSSVoiceEnum.html @@ -8,20 +8,28 @@ + + +
                                                    -

                                                    OSSSpeechKit 0.3.0 Docs (95% documented)

                                                    -

                                                    View on GitHub

                                                    +

                                                    OSSSpeechKit 1.0.0 Docs (100% documented)

                                                    +

                                                    GitHubView on GitHub

                                                    +
                                                    +
                                                    + +
                                                    +
                                                    @@ -34,6 +42,12 @@
                                                  • OSSSpeech
                                                    • +
                                                  • + OSSSpeechEngine +
                                                    • +
                                                  • + – State +
                                                  • OSSSpeechUtility
                                                    • @@ -48,12 +62,18 @@
                                                  • Enumerations
                                                      +
                                                    • + OSSSpeechError +
                                                    • OSSSpeechKitAuthorizationStatus
                                                    • OSSSpeechKitErrorType
                                                      • +
                                                    • + OSSSpeechRecognitionEvent +
                                                    • OSSSpeechRecognitionTaskType
                                                      • @@ -65,9 +85,6 @@
                                                    • Extensions
                                                        -
                                                      • - Bundle -
                                                      • NSObject
                                                        • @@ -84,6 +101,15 @@
                                                      • Structures
                                                          +
                                                        • + OSSLanguage +
                                                          • +
                                                        • + OSSUtteranceConfiguration +
                                                          • +
                                                        • + OSSVoiceConfiguration +
                                                        • OSSVoiceInfo
                                                          • @@ -97,7 +123,9 @@

                                                          OSSVoiceEnum

                                                          - 
                                                          public enum OSSVoiceEnum : String, CaseIterable
                                                          + + 
                                                          @available(*, deprecated, message: "Use OSSLanguage.catalog and runtime capability APIs.")
+public enum OSSVoiceEnum : String, CaseIterable
                                                          @@ -165,6 +193,33 @@

                                                          Declaration

                                                          +
                                                        • +
                                                          + + + + Bulgarian + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Bulgarian

                                                          + +
                                                          +
                                                          +

                                                          Declaration

                                                          +
                                                          +

                                                          Swift

                                                          + 
                                                          case Bulgarian = "bg-BG"
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                        • @@ -205,7 +260,7 @@

                                                          Declaration

                                                          -

                                                          Chinese

                                                          +

                                                          Chinese Traditional

                                                          @@ -219,6 +274,33 @@

                                                          Declaration

                                                          • +
                                                        • +
                                                          + + + + ChineseSimplified + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Chinese Simplified

                                                          + +
                                                          +
                                                          +

                                                          Declaration

                                                          +
                                                          +

                                                          Swift

                                                          + 
                                                          case ChineseSimplified = "zh-CN"
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                        • @@ -246,6 +328,33 @@

                                                          Declaration

                                                          • +
                                                        • +
                                                          + + + + Croatian + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Croatian

                                                          + +
                                                          +
                                                          +

                                                          Declaration

                                                          +
                                                          +

                                                          Swift

                                                          + 
                                                          case Croatian = "hr-HR"
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                        • @@ -570,6 +679,33 @@

                                                          Declaration

                                                          • +
                                                        • +
                                                          + + + + IndianEnglish + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Indian English

                                                          + +
                                                          +
                                                          +

                                                          Declaration

                                                          +
                                                          +

                                                          Swift

                                                          + 
                                                          case IndianEnglish = "en-IN"
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                        • @@ -705,6 +841,33 @@

                                                          Declaration

                                                          • +
                                                        • +
                                                          + + + + Malay + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Malaysian

                                                          + +
                                                          +
                                                          +

                                                          Declaration

                                                          +
                                                          +

                                                          Swift

                                                          + 
                                                          case Malay = "ms-MY"
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                        • @@ -759,6 +922,33 @@

                                                          Declaration

                                                          • +
                                                        • +
                                                          + + + + NorwegianBokmal + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Norwegian Bokmal

                                                          + +
                                                          +
                                                          +

                                                          Declaration

                                                          +
                                                          +

                                                          Swift

                                                          + 
                                                          case NorwegianBokmal = "nb-NO"
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                        • @@ -975,6 +1165,33 @@

                                                          Declaration

                                                          • +
                                                        • +
                                                          + + + + SpanishCatalan + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Catalan

                                                          + +
                                                          +
                                                          +

                                                          Declaration

                                                          +
                                                          +

                                                          Swift

                                                          + 
                                                          case SpanishCatalan = "ca-ES"
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                        • @@ -1083,6 +1300,33 @@

                                                          Declaration

                                                          • +
                                                        • +
                                                          + + + + Ukranian + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Ukranian

                                                          + +
                                                          +
                                                          +

                                                          Declaration

                                                          +
                                                          +

                                                          Swift

                                                          + 
                                                          case Ukranian = "uk-UA"
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                        • @@ -1110,6 +1354,60 @@

                                                          Declaration

                                                          • +
                                                        • +
                                                          + + + + Vietnamese + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Vietnamese

                                                          + +
                                                          +
                                                          +

                                                          Declaration

                                                          +
                                                          +

                                                          Swift

                                                          + 
                                                          case Vietnamese = "vi-VN"
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          • +
                                                        • +
                                                          + + + + ArabicWorld + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Arabic World

                                                          + +
                                                          +
                                                          +

                                                          Declaration

                                                          +
                                                          +

                                                          Swift

                                                          + 
                                                          case ArabicWorld = "ar-001"
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                        • @@ -1204,9 +1502,9 @@

                                                          Declaration

                                                          -

                                                          The flag for the selected language.

                                                          +

                                                          The legacy image flag for the selected language.

                                                          -

                                                          You can supply your own flag image, provided is has the same name (.rawValue) as the image in the pod assets.

                                                          +

                                                          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.

                                                          @@ -1215,7 +1513,119 @@

                                                          Declaration

                                                          Declaration

                                                          Swift

                                                          - 
                                                          public var flag: UIImage? { get }
                                                          + 
                                                          @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 }
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          • +
                                                        • +
                                                          + + + + languageMetadata + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Modern metadata corresponding to this legacy case.

                                                          + +
                                                          +
                                                          +

                                                          Declaration

                                                          +
                                                          +

                                                          Swift

                                                          + 
                                                          var languageMetadata: OSSLanguage { get }
                                                          + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          • +
                                                        • +
                                                          + + + + flagEmoji + +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          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
                                                          @@ -1227,11 +1637,10 @@

                                                          Declaration

                                                          - diff --git a/docs/Extensions.html b/docs/Extensions.html index f3d2a87..92cf5e1 100644 --- a/docs/Extensions.html +++ b/docs/Extensions.html @@ -8,20 +8,28 @@ + + +
                                                          -

                                                          OSSSpeechKit 0.3.0 Docs (95% documented)

                                                          -

                                                          View on GitHub

                                                          +

                                                          OSSSpeechKit 1.0.0 Docs (100% documented)

                                                          +

                                                          GitHubView on GitHub

                                                          +
                                                          +
                                                          + +
                                                          +
                                                          @@ -34,6 +42,12 @@
                                                        • OSSSpeech
                                                          • +
                                                        • + OSSSpeechEngine +
                                                          • +
                                                        • + – State +
                                                        • OSSSpeechUtility
                                                          • @@ -48,12 +62,18 @@
                                                        • Enumerations
                                                            +
                                                          • + OSSSpeechError +
                                                          • OSSSpeechKitAuthorizationStatus
                                                          • OSSSpeechKitErrorType
                                                            • +
                                                          • + OSSSpeechRecognitionEvent +
                                                          • OSSSpeechRecognitionTaskType
                                                            • @@ -65,9 +85,6 @@
                                                          • Extensions
                                                              -
                                                            • - Bundle -
                                                            • NSObject
                                                              • @@ -84,6 +101,15 @@
                                                            • Structures - diff --git a/docs/Extensions/Bundle.html b/docs/Extensions/Bundle.html deleted file mode 100644 index 506d3dd..0000000 --- a/docs/Extensions/Bundle.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - Bundle Extension Reference - - - - - - - - - - -
                                                              -
                                                              -

                                                              OSSSpeechKit 0.3.0 Docs (95% documented)

                                                              -

                                                              View on GitHub

                                                              -
                                                              -
                                                              -
                                                              - -
                                                              -
                                                              - -
                                                              -
                                                              -
                                                              -

                                                              Bundle

                                                              -
                                                              -
                                                              - 
                                                              extension Bundle
                                                              - -
                                                              -
                                                              -

                                                              Bundle extension to aid in retrieving the SDK resources for getting SDK images.

                                                              - -
                                                              -
                                                              -
                                                              -
                                                                -
                                                              • -
                                                                - - - - getResourcesBundle() - -
                                                                -
                                                                -
                                                                -
                                                                -
                                                                -
                                                                -

                                                                Will return the Bundle for the SDK if it can be found.

                                                                - -
                                                                -
                                                                -

                                                                Declaration

                                                                -
                                                                -

                                                                Swift

                                                                - 
                                                                static func getResourcesBundle() -> Bundle?
                                                                - -
                                                                -
                                                                -
                                                                -
                                                                -
                                                                • -
                                                              -
                                                              -
                                                              -
                                                              - -
                                                              -
                                                              - - - diff --git a/docs/Extensions/NSObject.html b/docs/Extensions/NSObject.html index e408c3c..69e7cc9 100644 --- a/docs/Extensions/NSObject.html +++ b/docs/Extensions/NSObject.html @@ -8,20 +8,28 @@ + + +
                                                              -

                                                              OSSSpeechKit 0.3.0 Docs (95% documented)

                                                              -

                                                              View on GitHub

                                                              +

                                                              OSSSpeechKit 1.0.0 Docs (100% documented)

                                                              +

                                                              GitHubView on GitHub

                                                              +
                                                              +
                                                              + +
                                                              +
                                                              @@ -34,6 +42,12 @@
                                                            • OSSSpeech
                                                              • +
                                                            • + OSSSpeechEngine +
                                                              • +
                                                            • + – State +
                                                            • OSSSpeechUtility
                                                              • @@ -48,12 +62,18 @@
                                                            • Enumerations
                                                                +
                                                              • + OSSSpeechError +
                                                              • OSSSpeechKitAuthorizationStatus
                                                              • OSSSpeechKitErrorType
                                                                • +
                                                              • + OSSSpeechRecognitionEvent +
                                                              • OSSSpeechRecognitionTaskType
                                                                • @@ -65,9 +85,6 @@
                                                              • Extensions
                                                                  -
                                                                • - Bundle -
                                                                • NSObject
                                                                  • @@ -84,6 +101,15 @@
                                                                • Structures
                                                                    +
                                                                  • + OSSLanguage +
                                                                    • +
                                                                  • + OSSUtteranceConfiguration +
                                                                    • +
                                                                  • + OSSVoiceConfiguration +
                                                                  • OSSVoiceInfo
                                                                    • @@ -97,6 +123,7 @@

                                                                    NSObject

                                                                    + 
                                                                    extension NSObject
                                                                    @@ -128,7 +155,8 @@

                                                                    NSObject

                                                                    Declaration

                                                                    Swift

                                                                    - 
                                                                    public func debugLog(object: Any, functionName: String = #function, fileName: String = #file, lineNumber: Int = #line, message: String)
                                                                    + 
                                                                    @available(*, deprecated, message: "Use OSLog from your application instead.")
+public func debugLog(object: Any, functionName: String = #function, fileName: String = #file, lineNumber: Int = #line, message: String)
                                                                    @@ -207,11 +235,10 @@

                                                                    Parameters

                                                                    - diff --git a/docs/OSSSpeechKit-Logo.png b/docs/OSSSpeechKit-Logo.png deleted file mode 100644 index 50e99ee..0000000 Binary files a/docs/OSSSpeechKit-Logo.png and /dev/null differ diff --git a/docs/Protocols.html b/docs/Protocols.html index 308a45c..6a0424e 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -8,20 +8,28 @@ + + +
                                                                    -

                                                                    OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                    -

                                                                    View on GitHub

                                                                    +

                                                                    OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                    +

                                                                    GitHubView on GitHub

                                                                    +
                                                                    +
                                                                    + +
                                                                    +
                                                                    @@ -34,6 +42,12 @@
                                                                  • OSSSpeech
                                                                    • +
                                                                  • + OSSSpeechEngine +
                                                                    • +
                                                                  • + – State +
                                                                  • OSSSpeechUtility
                                                                    • @@ -48,12 +62,18 @@
                                                                  • Enumerations
                                                                      +
                                                                    • + OSSSpeechError +
                                                                    • OSSSpeechKitAuthorizationStatus
                                                                    • OSSSpeechKitErrorType
                                                                      • +
                                                                    • + OSSSpeechRecognitionEvent +
                                                                    • OSSSpeechRecognitionTaskType
                                                                      • @@ -65,9 +85,6 @@
                                                                    • Extensions
                                                                        -
                                                                      • - Bundle -
                                                                      • NSObject
                                                                        • @@ -84,6 +101,15 @@
                                                                      • Structures
                                                                          +
                                                                        • + OSSLanguage +
                                                                          • +
                                                                        • + OSSUtteranceConfiguration +
                                                                          • +
                                                                        • + OSSVoiceConfiguration +
                                                                        • OSSVoiceInfo
                                                                          • @@ -122,7 +148,8 @@

                                                                          Protocols

                                                                          Declaration

                                                                          Swift

                                                                          - 
                                                                          public protocol OSSSpeechDelegate : AnyObject
                                                                          + 
                                                                          @available(*, deprecated, message: "Use OSSSpeechEngine async methods and recognition events.")
+public protocol OSSSpeechDelegate : AnyObject
                                                                          @@ -134,11 +161,10 @@

                                                                          Declaration

                                                                          - diff --git a/docs/Protocols/OSSSpeechDelegate.html b/docs/Protocols/OSSSpeechDelegate.html index 80bac84..26e7a5a 100644 --- a/docs/Protocols/OSSSpeechDelegate.html +++ b/docs/Protocols/OSSSpeechDelegate.html @@ -8,20 +8,28 @@ + + +
                                                                          -

                                                                          OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                          -

                                                                          View on GitHub

                                                                          +

                                                                          OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                          +

                                                                          GitHubView on GitHub

                                                                          +
                                                                          +
                                                                          + +
                                                                          +
                                                                          @@ -34,6 +42,12 @@
                                                                        • OSSSpeech
                                                                          • +
                                                                        • + OSSSpeechEngine +
                                                                          • +
                                                                        • + – State +
                                                                        • OSSSpeechUtility
                                                                          • @@ -48,12 +62,18 @@
                                                                        • Enumerations
                                                                            +
                                                                          • + OSSSpeechError +
                                                                          • OSSSpeechKitAuthorizationStatus
                                                                          • OSSSpeechKitErrorType
                                                                            • +
                                                                          • + OSSSpeechRecognitionEvent +
                                                                          • OSSSpeechRecognitionTaskType
                                                                            • @@ -65,9 +85,6 @@
                                                                          • Extensions
                                                                              -
                                                                            • - Bundle -
                                                                            • NSObject
                                                                              • @@ -84,6 +101,15 @@
                                                                            • Structures
                                                                                +
                                                                              • + OSSLanguage +
                                                                                • +
                                                                              • + OSSUtteranceConfiguration +
                                                                                • +
                                                                              • + OSSVoiceConfiguration +
                                                                              • OSSVoiceInfo
                                                                                • @@ -97,7 +123,9 @@

                                                                                OSSSpeechDelegate

                                                                                - 
                                                                                public protocol OSSSpeechDelegate : AnyObject
                                                                                + + 
                                                                                @available(*, deprecated, message: "Use OSSSpeechEngine async methods and recognition events.")
+public protocol OSSSpeechDelegate : AnyObject
                                                                                @@ -247,11 +275,10 @@

                                                                                Declaration

                                                                                - diff --git a/docs/Structs.html b/docs/Structs.html index 51f9549..a58eb0a 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -8,20 +8,28 @@ + + +
                                                                                -

                                                                                OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                -

                                                                                View on GitHub

                                                                                +

                                                                                OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                +

                                                                                GitHubView on GitHub

                                                                                +
                                                                                +
                                                                                + +
                                                                                +
                                                                                @@ -34,6 +42,12 @@
                                                                              • OSSSpeech
                                                                                • +
                                                                              • + OSSSpeechEngine +
                                                                                • +
                                                                              • + – State +
                                                                              • OSSSpeechUtility
                                                                                • @@ -48,12 +62,18 @@
                                                                              • Enumerations
                                                                                  +
                                                                                • + OSSSpeechError +
                                                                                • OSSSpeechKitAuthorizationStatus
                                                                                • OSSSpeechKitErrorType
                                                                                  • +
                                                                                • + OSSSpeechRecognitionEvent +
                                                                                • OSSSpeechRecognitionTaskType
                                                                                  • @@ -65,9 +85,6 @@
                                                                                • Extensions
                                                                                    -
                                                                                  • - Bundle -
                                                                                  • NSObject
                                                                                    • @@ -84,6 +101,15 @@
                                                                                  • Structures
                                                                                      +
                                                                                    • + OSSLanguage +
                                                                                      • +
                                                                                    • + OSSUtteranceConfiguration +
                                                                                      • +
                                                                                    • + OSSVoiceConfiguration +
                                                                                    • OSSVoiceInfo
                                                                                      • @@ -101,6 +127,95 @@

                                                                                      Structures

                                                                                        +
                                                                                      • +
                                                                                        + + + + OSSLanguage + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Display metadata for a language or regional voice supported by Apple platforms.

                                                                                        + +

                                                                                        The catalog is intentionally separate from runtime capabilities. Use +availableSynthesisVoices and supportsRecognition before presenting an +operation as available on the current device.

                                                                                        + + See more +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public struct OSSLanguage : Hashable, Identifiable, Sendable
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + OSSVoiceConfiguration + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Selects an actual voice exposed by AVFoundation.

                                                                                        + + See more +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public struct OSSVoiceConfiguration
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Value-style speech parameters used to construct a fresh AVFoundation +utterance for every synthesis request.

                                                                                        + + See more +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public struct OSSUtteranceConfiguration
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                      • @@ -114,7 +229,7 @@

                                                                                        Structures

                                                                                        -

                                                                                        The voice infor struct ensures that the data structure has conformity and consistency.

                                                                                        +

                                                                                        Information about a resolved system voice.

                                                                                        See more
                                                                                        @@ -122,7 +237,8 @@

                                                                                        Structures

                                                                                        Declaration

                                                                                        Swift

                                                                                        - 
                                                                                        public struct OSSVoiceInfo
                                                                                        + 
                                                                                        @available(*, deprecated, message: "Use OSSLanguage and AVSpeechSynthesisVoice directly.")
+public struct OSSVoiceInfo
                                                                                        @@ -134,11 +250,10 @@

                                                                                        Declaration

                                                                                      - diff --git a/docs/Structs/OSSLanguage.html b/docs/Structs/OSSLanguage.html new file mode 100644 index 0000000..97e79d5 --- /dev/null +++ b/docs/Structs/OSSLanguage.html @@ -0,0 +1,586 @@ + + + + OSSLanguage Structure Reference + + + + + + + + + + + + + +
                                                                                      +
                                                                                      +

                                                                                      OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                      +

                                                                                      GitHubView on GitHub

                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      OSSLanguage

                                                                                      +
                                                                                      +
                                                                                      + + 
                                                                                      public struct OSSLanguage : Hashable, Identifiable, Sendable
                                                                                      + +
                                                                                      +
                                                                                      +

                                                                                      Display metadata for a language or regional voice supported by Apple platforms.

                                                                                      + +

                                                                                      The catalog is intentionally separate from runtime capabilities. Use +availableSynthesisVoices and supportsRecognition before presenting an +operation as available on the current device.

                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                        +
                                                                                      • +
                                                                                        + + + + id + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Stable identifier used by OSSSpeechKit to refer to this catalog entry.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public let id: String
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + name + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Human-readable language or regional variant name for display.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public let name: String
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + locale + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Foundation locale that describes the language and region.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public let locale: Locale
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + regionCode + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Region override used when the locale alone cannot distinguish a variant.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public let regionCode: String?
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Voice identifiers that should be preferred when matching installed voices.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public let preferredVoiceIdentifiers: [String]
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Creates language metadata for the OSSSpeechKit catalog.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public init(
+    id: String,
+    name: String,
+    localeIdentifier: String,
+    regionCode: String? = nil,
+    preferredVoiceIdentifiers: [String] = []
+)
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Parameters

                                                                                        + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                        + + id + + +
                                                                                        +

                                                                                        Stable catalog identifier.

                                                                                        +
                                                                                        +
                                                                                        + + name + + +
                                                                                        +

                                                                                        Human-readable display name.

                                                                                        +
                                                                                        +
                                                                                        + + localeIdentifier + + +
                                                                                        +

                                                                                        BCP 47 identifier for the language and region.

                                                                                        +
                                                                                        +
                                                                                        + + regionCode + + +
                                                                                        +

                                                                                        Optional region override for variants that share a locale.

                                                                                        +
                                                                                        +
                                                                                        + + preferredVoiceIdentifiers + + +
                                                                                        +

                                                                                        Preferred AVFoundation voice identifiers.

                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + localeIdentifier + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        The canonicalized BCP 47 identifier used for runtime capability checks.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public var localeIdentifier: String { get }
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Voices currently installed or exposed by the operating system.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public var availableSynthesisVoices: [AVSpeechSynthesisVoice] { get }
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + supportsRecognition + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Whether the legacy Speech recognizer reports this locale as supported.

                                                                                        + +

                                                                                        Support does not imply that Apple’s service is currently available.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public var supportsRecognition: Bool { get }
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Returns the exact supported recognition locale, or a same-language, +same-region canonical equivalent. It never silently changes regions.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public static func supportedRecognitionLocale(equivalentTo locale: Locale) -> Locale?
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + flagEmoji + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        A Unicode flag suitable for labels, SwiftUI Text, and accessibility.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        var flagEmoji: String { get }
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Renders flagEmoji to an image for UIKit clients that require one.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

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

                                                                                        Curated languages and regional variants described by Apple’s current +VoiceOver and Dictation availability documentation.

                                                                                        + +

                                                                                        Availability still varies by OS release, device, installed assets, and +network access. Filter this catalog using the runtime capability APIs.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        static let catalog: [OSSLanguage]
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + + diff --git a/docs/Structs/OSSUtteranceConfiguration.html b/docs/Structs/OSSUtteranceConfiguration.html new file mode 100644 index 0000000..26d8cf8 --- /dev/null +++ b/docs/Structs/OSSUtteranceConfiguration.html @@ -0,0 +1,384 @@ + + + + OSSUtteranceConfiguration Structure Reference + + + + + + + + + + + + + +
                                                                                      +
                                                                                      +

                                                                                      OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                      +

                                                                                      GitHubView on GitHub

                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      OSSUtteranceConfiguration

                                                                                      +
                                                                                      +
                                                                                      + + 
                                                                                      public struct OSSUtteranceConfiguration
                                                                                      + +
                                                                                      +
                                                                                      +

                                                                                      Value-style speech parameters used to construct a fresh AVFoundation +utterance for every synthesis request.

                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                        +
                                                                                      • +
                                                                                        + + + + rate + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Speech rate to apply to the utterance.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public var rate: Float
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + pitchMultiplier + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Pitch multiplier to apply to the utterance.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public var pitchMultiplier: Float
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + volume + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Playback volume to apply to the utterance.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public var volume: Float
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + preUtteranceDelay + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Delay before the utterance begins speaking.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public var preUtteranceDelay: TimeInterval
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + postUtteranceDelay + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Delay after the utterance finishes speaking.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public var postUtteranceDelay: TimeInterval
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Creates speech synthesis parameters for an utterance.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public init(
+    rate: Float = AVSpeechUtteranceDefaultSpeechRate,
+    pitchMultiplier: Float = 1,
+    volume: Float = 1,
+    preUtteranceDelay: TimeInterval = 0,
+    postUtteranceDelay: TimeInterval = 0
+)
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Parameters

                                                                                        + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                        + + rate + + +
                                                                                        +

                                                                                        Speech rate to apply.

                                                                                        +
                                                                                        +
                                                                                        + + pitchMultiplier + + +
                                                                                        +

                                                                                        Pitch multiplier to apply.

                                                                                        +
                                                                                        +
                                                                                        + + volume + + +
                                                                                        +

                                                                                        Playback volume to apply.

                                                                                        +
                                                                                        +
                                                                                        + + preUtteranceDelay + + +
                                                                                        +

                                                                                        Delay before speaking begins.

                                                                                        +
                                                                                        +
                                                                                        + + postUtteranceDelay + + +
                                                                                        +

                                                                                        Delay after speaking finishes.

                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + + diff --git a/docs/Structs/OSSVoiceConfiguration.html b/docs/Structs/OSSVoiceConfiguration.html new file mode 100644 index 0000000..6759b6a --- /dev/null +++ b/docs/Structs/OSSVoiceConfiguration.html @@ -0,0 +1,331 @@ + + + + OSSVoiceConfiguration Structure Reference + + + + + + + + + + + + + +
                                                                                      +
                                                                                      +

                                                                                      OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                      +

                                                                                      GitHubView on GitHub

                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                      +

                                                                                      OSSVoiceConfiguration

                                                                                      +
                                                                                      +
                                                                                      + + 
                                                                                      public struct OSSVoiceConfiguration
                                                                                      + +
                                                                                      +
                                                                                      +

                                                                                      Selects an actual voice exposed by AVFoundation.

                                                                                      + +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                        +
                                                                                      • +
                                                                                        + + + + language + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Language or regional variant used to search installed voices.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public var language: OSSLanguage
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + preferredIdentifier + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Specific AVFoundation voice identifier to prefer when available.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public var preferredIdentifier: String?
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + preferredQuality + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Preferred voice quality to use when multiple voices match the language.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public var preferredQuality: AVSpeechSynthesisVoiceQuality?
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Creates a voice selection request.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public init(
+    language: OSSLanguage,
+    preferredIdentifier: String? = nil,
+    preferredQuality: AVSpeechSynthesisVoiceQuality? = nil
+)
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Parameters

                                                                                        + + + + + + + + + + + + + + + +
                                                                                        + + language + + +
                                                                                        +

                                                                                        Language metadata used to find matching voices.

                                                                                        +
                                                                                        +
                                                                                        + + preferredIdentifier + + +
                                                                                        +

                                                                                        Optional exact AVFoundation voice identifier.

                                                                                        +
                                                                                        +
                                                                                        + + preferredQuality + + +
                                                                                        +

                                                                                        Optional quality preference for matched voices.

                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      • +
                                                                                        + + + + resolve() + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +

                                                                                        Resolves the best currently available system voice without relying on +AVFoundation’s silent cross-region fallback.

                                                                                        + +
                                                                                        +
                                                                                        +

                                                                                        Declaration

                                                                                        +
                                                                                        +

                                                                                        Swift

                                                                                        + 
                                                                                        public func resolve() -> AVSpeechSynthesisVoice?
                                                                                        + +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        +
                                                                                        • +
                                                                                      +
                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      + + diff --git a/docs/Structs/OSSVoiceInfo.html b/docs/Structs/OSSVoiceInfo.html index fab8c20..c619ff7 100644 --- a/docs/Structs/OSSVoiceInfo.html +++ b/docs/Structs/OSSVoiceInfo.html @@ -8,20 +8,28 @@ + + +
                                                                                      -

                                                                                      OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                      -

                                                                                      View on GitHub

                                                                                      +

                                                                                      OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                      +

                                                                                      GitHubView on GitHub

                                                                                      +
                                                                                      +
                                                                                      + +
                                                                                      +
                                                                                      @@ -34,6 +42,12 @@
                                                                                    • OSSSpeech
                                                                                      • +
                                                                                    • + OSSSpeechEngine +
                                                                                      • +
                                                                                    • + – State +
                                                                                    • OSSSpeechUtility
                                                                                      • @@ -48,12 +62,18 @@
                                                                                    • Enumerations
                                                                                        +
                                                                                      • + OSSSpeechError +
                                                                                      • OSSSpeechKitAuthorizationStatus
                                                                                      • OSSSpeechKitErrorType
                                                                                        • +
                                                                                      • + OSSSpeechRecognitionEvent +
                                                                                      • OSSSpeechRecognitionTaskType
                                                                                        • @@ -65,9 +85,6 @@
                                                                                      • Extensions
                                                                                          -
                                                                                        • - Bundle -
                                                                                        • NSObject
                                                                                          • @@ -84,6 +101,15 @@
                                                                                        • Structures
                                                                                            +
                                                                                          • + OSSLanguage +
                                                                                            • +
                                                                                          • + OSSUtteranceConfiguration +
                                                                                            • +
                                                                                          • + OSSVoiceConfiguration +
                                                                                          • OSSVoiceInfo
                                                                                            • @@ -97,11 +123,13 @@

                                                                                            OSSVoiceInfo

                                                                                            - 
                                                                                            public struct OSSVoiceInfo
                                                                                            + + 
                                                                                            @available(*, deprecated, message: "Use OSSLanguage and AVSpeechSynthesisVoice directly.")
+public struct OSSVoiceInfo
                                                                                            -

                                                                                            The voice infor struct ensures that the data structure has conformity and consistency.

                                                                                            +

                                                                                            Information about a resolved system voice.

                                                                                            @@ -201,14 +229,42 @@

                                                                                            Declaration

                                                                                            -

                                                                                            Identifier is a unique bundle url provided by Apple for each AVSpeechSynthesisVoice.

                                                                                            +

                                                                                            Identifier is a unique bundle URL provided by Apple for each voice.

                                                                                            + +
                                                                                            +
                                                                                            +

                                                                                            Declaration

                                                                                            +
                                                                                            +

                                                                                            Swift

                                                                                            + 
                                                                                            @available(*, deprecated, message: "Use voiceIdentifier.")
+public var identifier: Any?
                                                                                            + +
                                                                                            +
                                                                                            +
                                                                                            + + +
                                                                                          • +
                                                                                            + + + + voiceIdentifier + +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +
                                                                                            +

                                                                                            Typed identifier for the resolved AVSpeechSynthesisVoice.

                                                                                            Declaration

                                                                                            Swift

                                                                                            - 
                                                                                            public var identifier: Any?
                                                                                            + 
                                                                                            public var voiceIdentifier: String?
                                                                                            @@ -220,11 +276,10 @@

                                                                                            Declaration

                                                                                            • - diff --git a/docs/badge.svg b/docs/badge.svg index 19d671e..a096fec 100644 --- a/docs/badge.svg +++ b/docs/badge.svg @@ -1,15 +1,15 @@ - + - + - - + + @@ -18,11 +18,11 @@ documentation - - 95% + + 100% - - 95% + + 100% diff --git a/docs/css/highlight.css b/docs/css/highlight.css index d0db0e1..c170357 100644 --- a/docs/css/highlight.css +++ b/docs/css/highlight.css @@ -1,200 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ /* Credit to https://gist.github.com/wataru420/2048287 */ -.highlight { - /* Comment */ - /* Error */ - /* Keyword */ - /* Operator */ - /* Comment.Multiline */ - /* Comment.Preproc */ - /* Comment.Single */ - /* Comment.Special */ - /* Generic.Deleted */ - /* Generic.Deleted.Specific */ - /* Generic.Emph */ - /* Generic.Error */ - /* Generic.Heading */ - /* Generic.Inserted */ - /* Generic.Inserted.Specific */ - /* Generic.Output */ - /* Generic.Prompt */ - /* Generic.Strong */ - /* Generic.Subheading */ - /* Generic.Traceback */ - /* Keyword.Constant */ - /* Keyword.Declaration */ - /* Keyword.Pseudo */ - /* Keyword.Reserved */ - /* Keyword.Type */ - /* Literal.Number */ - /* Literal.String */ - /* Name.Attribute */ - /* Name.Builtin */ - /* Name.Class */ - /* Name.Constant */ - /* Name.Entity */ - /* Name.Exception */ - /* Name.Function */ - /* Name.Namespace */ - /* Name.Tag */ - /* Name.Variable */ - /* Operator.Word */ - /* Text.Whitespace */ - /* Literal.Number.Float */ - /* Literal.Number.Hex */ - /* Literal.Number.Integer */ - /* Literal.Number.Oct */ - /* Literal.String.Backtick */ - /* Literal.String.Char */ - /* Literal.String.Doc */ - /* Literal.String.Double */ - /* Literal.String.Escape */ - /* Literal.String.Heredoc */ - /* Literal.String.Interpol */ - /* Literal.String.Other */ - /* Literal.String.Regex */ - /* Literal.String.Single */ - /* Literal.String.Symbol */ - /* Name.Builtin.Pseudo */ - /* Name.Variable.Class */ - /* Name.Variable.Global */ - /* Name.Variable.Instance */ - /* Literal.Number.Integer.Long */ } - .highlight .c { - color: #999988; - font-style: italic; } - .highlight .err { - color: #a61717; - background-color: #e3d2d2; } - .highlight .k { - color: #000000; - font-weight: bold; } - .highlight .o { - color: #000000; - font-weight: bold; } - .highlight .cm { - color: #999988; - font-style: italic; } - .highlight .cp { - color: #999999; - font-weight: bold; } - .highlight .c1 { - color: #999988; - font-style: italic; } - .highlight .cs { - color: #999999; - font-weight: bold; - font-style: italic; } - .highlight .gd { - color: #000000; - background-color: #ffdddd; } - .highlight .gd .x { - color: #000000; - background-color: #ffaaaa; } - .highlight .ge { - color: #000000; - font-style: italic; } - .highlight .gr { - color: #aa0000; } - .highlight .gh { - color: #999999; } - .highlight .gi { - color: #000000; - background-color: #ddffdd; } - .highlight .gi .x { - color: #000000; - background-color: #aaffaa; } - .highlight .go { - color: #888888; } - .highlight .gp { - color: #555555; } - .highlight .gs { - font-weight: bold; } - .highlight .gu { - color: #aaaaaa; } - .highlight .gt { - color: #aa0000; } - .highlight .kc { - color: #000000; - font-weight: bold; } - .highlight .kd { - color: #000000; - font-weight: bold; } - .highlight .kp { - color: #000000; - font-weight: bold; } - .highlight .kr { - color: #000000; - font-weight: bold; } - .highlight .kt { - color: #445588; } - .highlight .m { - color: #009999; } - .highlight .s { - color: #d14; } - .highlight .na { - color: #008080; } - .highlight .nb { - color: #0086B3; } - .highlight .nc { - color: #445588; - font-weight: bold; } - .highlight .no { - color: #008080; } - .highlight .ni { - color: #800080; } - .highlight .ne { - color: #990000; - font-weight: bold; } - .highlight .nf { - color: #990000; } - .highlight .nn { - color: #555555; } - .highlight .nt { - color: #000080; } - .highlight .nv { - color: #008080; } - .highlight .ow { - color: #000000; - font-weight: bold; } - .highlight .w { - color: #bbbbbb; } - .highlight .mf { - color: #009999; } - .highlight .mh { - color: #009999; } - .highlight .mi { - color: #009999; } - .highlight .mo { - color: #009999; } - .highlight .sb { - color: #d14; } - .highlight .sc { - color: #d14; } - .highlight .sd { - color: #d14; } - .highlight .s2 { - color: #d14; } - .highlight .se { - color: #d14; } - .highlight .sh { - color: #d14; } - .highlight .si { - color: #d14; } - .highlight .sx { - color: #d14; } - .highlight .sr { - color: #009926; } - .highlight .s1 { - color: #d14; } - .highlight .ss { - color: #990073; } - .highlight .bp { - color: #999999; } - .highlight .vc { - color: #008080; } - .highlight .vg { - color: #008080; } - .highlight .vi { - color: #008080; } - .highlight .il { - color: #009999; } +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/docs/css/jazzy.css b/docs/css/jazzy.css index c3090c0..2e38713 100644 --- a/docs/css/jazzy.css +++ b/docs/css/jazzy.css @@ -1,3 +1,7 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td { background: transparent; border: 0; @@ -56,9 +60,14 @@ p code, li code { padding: 2px 4px; border-radius: 4px; } +pre > code { + padding: 0; } + a { color: #0088cc; text-decoration: none; } + a code { + color: inherit; } ul { padding-left: 15px; } @@ -74,20 +83,32 @@ blockquote { padding: 0 10px; border-left: 4px solid #ccc; } +hr { + height: 1px; + border: none; + background-color: #e2e2e2; } + +.footnote-ref { + display: inline-block; + scroll-margin-top: 70px; } + +.footnote-def { + scroll-margin-top: 70px; } + .content-wrapper { margin: 0 auto; width: 980px; } header { font-size: 0.85em; - line-height: 26px; + line-height: 32px; background-color: #414141; position: fixed; width: 100%; - z-index: 2; } + z-index: 3; } header img { padding-right: 6px; - vertical-align: -4px; + vertical-align: -3px; height: 16px; } header a { color: #fff; } @@ -100,12 +121,12 @@ header { #breadcrumbs { background-color: #f2f2f2; - height: 27px; + height: 21px; padding-top: 17px; position: fixed; width: 100%; z-index: 2; - margin-top: 26px; } + margin-top: 32px; } #breadcrumbs #carat { height: 10px; margin: 0 5px; } @@ -199,6 +220,7 @@ header { margin-left: 18px; } .task-group-section { + margin-top: 10px; padding-left: 6px; border-top: 1px solid #e2e2e2; } @@ -372,3 +394,46 @@ html.dash .content-wrapper { html.dash #footer { position: static; } + +form[role=search] { + float: right; } + form[role=search] input { + font: Helvetica, freesans, Arial, sans-serif; + margin-top: 6px; + font-size: 13px; + line-height: 20px; + padding: 0px 10px; + border: none; + border-radius: 1em; } + .loading form[role=search] input { + background: white url(../img/spinner.gif) center right 4px no-repeat; } + form[role=search] .tt-menu { + margin: 0; + min-width: 300px; + background: #fff; + color: #333; + border: 1px solid #e2e2e2; + z-index: 4; } + form[role=search] .tt-highlight { + font-weight: bold; } + form[role=search] .tt-suggestion { + font: Helvetica, freesans, Arial, sans-serif; + font-size: 14px; + padding: 0 8px; } + form[role=search] .tt-suggestion span { + display: table-cell; + white-space: nowrap; } + form[role=search] .tt-suggestion .doc-parent-name { + width: 100%; + text-align: right; + font-weight: normal; + font-size: 0.9em; + padding-left: 16px; } + form[role=search] .tt-suggestion:hover, + form[role=search] .tt-suggestion.tt-cursor { + cursor: pointer; + background-color: #4183c4; + color: #fff; } + form[role=search] .tt-suggestion:hover .doc-parent-name, + form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { + color: #fff; } diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes.html index c1f50c0..b1f9c19 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes.html @@ -8,20 +8,28 @@ + + +
                                                                                            -

                                                                                            OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                            -

                                                                                            View on GitHub

                                                                                            +

                                                                                            OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                            +

                                                                                            GitHubView on GitHub

                                                                                            +
                                                                                            +
                                                                                            + +
                                                                                            +
                                                                                            @@ -34,6 +42,12 @@
                                                                                          • OSSSpeech
                                                                                            • +
                                                                                          • + OSSSpeechEngine +
                                                                                            • +
                                                                                          • + – State +
                                                                                          • OSSSpeechUtility
                                                                                            • @@ -48,12 +62,18 @@
                                                                                          • Enumerations
                                                                                              +
                                                                                            • + OSSSpeechError +
                                                                                            • OSSSpeechKitAuthorizationStatus
                                                                                            • OSSSpeechKitErrorType
                                                                                              • +
                                                                                            • + OSSSpeechRecognitionEvent +
                                                                                            • OSSSpeechRecognitionTaskType
                                                                                              • @@ -65,9 +85,6 @@
                                                                                            • Extensions
                                                                                                -
                                                                                              • - Bundle -
                                                                                              • NSObject
                                                                                                • @@ -84,6 +101,15 @@
                                                                                              • Structures
                                                                                                  +
                                                                                                • + OSSLanguage +
                                                                                                  • +
                                                                                                • + OSSUtteranceConfiguration +
                                                                                                  • +
                                                                                                • + OSSVoiceConfiguration +
                                                                                                • OSSVoiceInfo
                                                                                                  • @@ -122,7 +148,8 @@

                                                                                                  Classes

                                                                                                  Declaration

                                                                                                  Swift

                                                                                                  - 
                                                                                                  public class OSSSpeech : NSObject
                                                                                                  + 
                                                                                                  @available(*, deprecated, message: "Use the instance-based OSSSpeechEngine async API.")
+public class OSSSpeech : NSObject, @unchecked Sendable
                                                                                                  extension OSSSpeech: SFSpeechRecognitionTaskDelegate, SFSpeechRecognizerDelegate
                                                                                                  @@ -130,6 +157,36 @@

                                                                                                  Declaration

                                                                                                  +
                                                                                                • +
                                                                                                  + + + + OSSSpeechEngine + +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +

                                                                                                  Instance-based, main-actor-isolated speech synthesis and recognition engine.

                                                                                                  + + See more +
                                                                                                  +
                                                                                                  +

                                                                                                  Declaration

                                                                                                  +
                                                                                                  +

                                                                                                  Swift

                                                                                                  + 
                                                                                                  @MainActor
+public final class OSSSpeechEngine : NSObject
                                                                                                  +
                                                                                                  extension OSSSpeechEngine: AVSpeechSynthesizerDelegate, SFSpeechRecognizerDelegate
                                                                                                  + +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                  +
                                                                                                • @@ -143,7 +200,7 @@

                                                                                                  Declaration

                                                                                                  -

                                                                                                  Undocumented

                                                                                                  +

                                                                                                  Utility methods for localized strings and diagnostics used by OSSSpeechKit.

                                                                                                  See more
                                                                                                  @@ -183,7 +240,8 @@

                                                                                                  Declaration

                                                                                                  Declaration

                                                                                                  Swift

                                                                                                  - 
                                                                                                  public class OSSUtterance : AVSpeechUtterance
                                                                                                  + 
                                                                                                  @available(*, deprecated, message: "Use OSSUtteranceConfiguration with OSSSpeechEngine.")
+public class OSSUtterance : AVSpeechUtterance
                                                                                                  @@ -220,8 +278,8 @@

                                                                                                  Declaration

                                                                                                  Declaration

                                                                                                  Swift

                                                                                                  - 
                                                                                                  @available(iOS 9.0, *)
-public class OSSVoice : AVSpeechSynthesisVoice
                                                                                                  + 
                                                                                                  @available(*, deprecated, message: "Use OSSVoiceConfiguration, which resolves a real AVSpeechSynthesisVoice.")
+public class OSSVoice : AVSpeechSynthesisVoice, @unchecked Sendable
                                                                                                  @@ -233,11 +291,10 @@

                                                                                                  Declaration

                                                                                                  - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeech.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeech.html index 9bb94ab..f5bcf08 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeech.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeech.html @@ -8,20 +8,28 @@ + + +
                                                                                                  -

                                                                                                  OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                  -

                                                                                                  View on GitHub

                                                                                                  +

                                                                                                  OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                  +

                                                                                                  GitHubView on GitHub

                                                                                                  +
                                                                                                  +
                                                                                                  + +
                                                                                                  +
                                                                                                  @@ -34,6 +42,12 @@
                                                                                                • OSSSpeech
                                                                                                  • +
                                                                                                • + OSSSpeechEngine +
                                                                                                  • +
                                                                                                • + – State +
                                                                                                • OSSSpeechUtility
                                                                                                  • @@ -48,12 +62,18 @@
                                                                                                • Enumerations
                                                                                                    +
                                                                                                  • + OSSSpeechError +
                                                                                                  • OSSSpeechKitAuthorizationStatus
                                                                                                  • OSSSpeechKitErrorType
                                                                                                    • +
                                                                                                  • + OSSSpeechRecognitionEvent +
                                                                                                  • OSSSpeechRecognitionTaskType
                                                                                                    • @@ -65,9 +85,6 @@
                                                                                                  • Extensions
                                                                                                      -
                                                                                                    • - Bundle -
                                                                                                    • NSObject
                                                                                                      • @@ -84,6 +101,15 @@
                                                                                                    • Structures
                                                                                                        +
                                                                                                      • + OSSLanguage +
                                                                                                        • +
                                                                                                      • + OSSUtteranceConfiguration +
                                                                                                        • +
                                                                                                      • + OSSVoiceConfiguration +
                                                                                                      • OSSVoiceInfo
                                                                                                        • @@ -97,7 +123,9 @@

                                                                                                        OSSSpeech

                                                                                                        - 
                                                                                                        public class OSSSpeech : NSObject
                                                                                                        + + 
                                                                                                        @available(*, deprecated, message: "Use the instance-based OSSSpeechEngine async API.")
+public class OSSSpeech : NSObject, @unchecked Sendable
                                                                                                        extension OSSSpeech: SFSpeechRecognitionTaskDelegate, SFSpeechRecognizerDelegate
                                                                                                        @@ -112,7 +140,7 @@

                                                                                                        OSSSpeech

                                                                                                        -

                                                                                                        Variables

                                                                                                        +

                                                                                                        Variables

                                                                                                        @@ -308,7 +336,8 @@

                                                                                                        Declaration

                                                                                                        Declaration

                                                                                                        Swift

                                                                                                        - 
                                                                                                        public var srp: SFSpeechRecognizer.Type
                                                                                                        + 
                                                                                                        @available(*, deprecated, message: "Use dependency injection with OSSSpeechEngine tests.")
+public var srp: SFSpeechRecognizer.Type
                                                                                                        @@ -323,11 +352,40 @@

                                                                                                        Declaration

                                                                                                        -

                                                                                                        Lifecycle

                                                                                                        +

                                                                                                        Lifecycle

                                                                                                          +
                                                                                                        • + +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          Allow injection of the AVSpeechSynthesizer so that caller can be AVSpeechSynthesizerDelegate + func speechSynthesizer(_ synthesizer: AVSpeechSynthesizer, willSpeakRangeOfSpeechString characterRange: NSRange, utterance: AVSpeechUtterance) { + func speechSynthesizer(_ synthesizer: AVSpeechSynthesizer, didFinish utterance: AVSpeechUtterance) {

                                                                                                          + +
                                                                                                          +
                                                                                                          +

                                                                                                          Declaration

                                                                                                          +
                                                                                                          +

                                                                                                          Swift

                                                                                                          + 
                                                                                                          public init(speechSynthesizer: AVSpeechSynthesizer = AVSpeechSynthesizer())
                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                        • @@ -348,7 +406,8 @@

                                                                                                          Lifecycle

                                                                                                          Declaration

                                                                                                          Swift

                                                                                                          - 
                                                                                                          public class var shared: OSSSpeech { get }
                                                                                                          + 
                                                                                                          @available(*, deprecated, message: "Create an OSSSpeechEngine instance instead.")
+public class var shared: OSSSpeech { get }
                                                                                                          @@ -363,7 +422,7 @@

                                                                                                          Declaration

                                                                                                          -

                                                                                                          Public Methods

                                                                                                          +

                                                                                                          Public Methods

                                                                                                          @@ -462,25 +521,12 @@

                                                                                                          Parameters

                                                                                                          • -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - -
                                                                                                        - -

                                                                                                        Public Voice Recording Methods

                                                                                                        -

                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        • @@ -488,18 +534,45 @@

                                                                                                          Public Voice Recording Methods

                                                                                                          -

                                                                                                          Record and recognise speech

                                                                                                          +

                                                                                                          Pause speaking text

                                                                                                          -

                                                                                                          This method will check to see if user is authorised to record. If they are, the recording will proceed.

                                                                                                          +

                                                                                                          Will check if the current speech synthesizer session is speaking before attempting to pause.

                                                                                                          -

                                                                                                          Upon checking the authorisation and being registered successful, a check to determine if a recording session is active will be made and any active session will be cancelled.

                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          Declaration

                                                                                                          +
                                                                                                          +

                                                                                                          Swift

                                                                                                          + 
                                                                                                          public func pauseSpeaking()
                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          +
                                                                                                          • +
                                                                                                        • +
                                                                                                          + + + + continueSpeaking() + +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          Continue speaking text

                                                                                                          + +

                                                                                                          Will check if the current speech synthesizer session is paused before attempting to continue speaking.

                                                                                                          Declaration

                                                                                                          Swift

                                                                                                          - 
                                                                                                          public func recordVoice(requestMicPermission requested: Bool = true)
                                                                                                          + 
                                                                                                          public func continueSpeaking()
                                                                                                          @@ -509,9 +582,9 @@

                                                                                                          Declaration

                                                                                                        • @@ -519,14 +592,17 @@

                                                                                                          Declaration

                                                                                                          -

                                                                                                          End recording of speech session if one exists.

                                                                                                          +

                                                                                                          Force the ending of speaking.

                                                                                                          + +

                                                                                                          Does not remove or reset the utterance or voice - only stops the current speaking if it’s active. +Also checks to see if the current synthesizer session is paused.

                                                                                                          Declaration

                                                                                                          Swift

                                                                                                          - 
                                                                                                          public func endVoiceRecording()
                                                                                                          + 
                                                                                                          public func stopSpeaking()
                                                                                                          @@ -537,11 +613,11 @@

                                                                                                          Declaration

                                                                                                          - - + +
                                                                                                          - -

                                                                                                          Private Voice Recording

                                                                                                          + +

                                                                                                          Public Voice Recording Methods

                                                                                                          @@ -549,9 +625,40 @@

                                                                                                          Private Voice Recording

                                                                                                        • +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          Record and recognise speech

                                                                                                          + +

                                                                                                          This method will check to see if user is authorised to record. If they are, the recording will proceed.

                                                                                                          + +

                                                                                                          Upon checking the authorisation and being registered successful, a check to determine if a recording session is active will be made and any active session will be cancelled.

                                                                                                          + +
                                                                                                          +
                                                                                                          +

                                                                                                          Declaration

                                                                                                          +
                                                                                                          +

                                                                                                          Swift

                                                                                                          + 
                                                                                                          public func recordVoice(requestMicPermission requested: Bool = true)
                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          • +
                                                                                                        • +
                                                                                                          @@ -559,14 +666,14 @@

                                                                                                          Private Voice Recording

                                                                                                          -

                                                                                                          Undocumented

                                                                                                          +

                                                                                                          End recording of speech session if one exists.

                                                                                                          Declaration

                                                                                                          Swift

                                                                                                          - 
                                                                                                          func engineSetup(_ engine: AVAudioEngine) -> Bool
                                                                                                          + 
                                                                                                          public func endVoiceRecording()
                                                                                                          @@ -581,7 +688,7 @@

                                                                                                          Declaration

                                                                                                          -

                                                                                                          SFSpeechRecognitionTaskDelegate Methods

                                                                                                          +

                                                                                                          SFSpeechRecognitionTaskDelegate Methods

                                                                                                          @@ -680,7 +787,7 @@

                                                                                                          Declaration

                                                                                                          -

                                                                                                          Undocumented

                                                                                                          +

                                                                                                          Called when the recognizer detects speech in the audio stream.

                                                                                                          @@ -707,7 +814,7 @@

                                                                                                          Declaration

                                                                                                          -

                                                                                                          Undocumented

                                                                                                          +

                                                                                                          Called when the recognizer has finished reading audio from the request.

                                                                                                          @@ -729,7 +836,7 @@

                                                                                                          Declaration

                                                                                                          -

                                                                                                          SFSpeechRecognizerDelegate Methods

                                                                                                          +

                                                                                                          SFSpeechRecognizerDelegate Methods

                                                                                                          @@ -766,11 +873,10 @@

                                                                                                          Declaration

                                                                                                          • -
                                                                                                          • diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeechEngine.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeechEngine.html new file mode 100644 index 0000000..5030a3c --- /dev/null +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeechEngine.html @@ -0,0 +1,687 @@ + + + + OSSSpeechEngine Class Reference + + + + + + + + + + + + + +
                                                                                                          +
                                                                                                          +

                                                                                                          OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                          +

                                                                                                          GitHubView on GitHub

                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          OSSSpeechEngine

                                                                                                          +
                                                                                                          +
                                                                                                          + + 
                                                                                                          @MainActor
+public final class OSSSpeechEngine : NSObject
                                                                                                          +
                                                                                                          extension OSSSpeechEngine: AVSpeechSynthesizerDelegate, SFSpeechRecognizerDelegate
                                                                                                          + +
                                                                                                          +
                                                                                                          +

                                                                                                          Instance-based, main-actor-isolated speech synthesis and recognition engine.

                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                            +
                                                                                                          • +
                                                                                                            + + + + State + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Current high-level activity of the speech engine.

                                                                                                            + + See more +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            public enum State : Equatable
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + state + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Current high-level activity of the engine.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public private(set) var state: State { get }
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Whether recognition should require on-device processing when supported.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public var usesOnDeviceRecognition: Bool
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + recognitionTaskHint + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Task hint passed to the underlying speech recognizer.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public var recognitionTaskHint: SFSpeechRecognitionTaskHint
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + init() + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Creates a speech engine with its own synthesizer, audio engine, and audio session.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public override init()
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Locales that the platform reports as available for speech recognition.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public static var supportedRecognitionLocales: Set<Locale> { get }
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + requestSpeechAuthorization() + + + Asynchronous + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Requests speech recognition authorization and maps the native status.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public func requestSpeechAuthorization() async -> OSSSpeechKitAuthorizationStatus
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + requestMicrophoneAuthorization() + + + Asynchronous + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Requests microphone recording authorization.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public func requestMicrophoneAuthorization() async -> Bool
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + speak(_:voice:configuration:) + + + Asynchronous + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Speaks plain text using a resolved AVFoundation voice.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public func speak(
+    _ text: String,
+    voice: OSSVoiceConfiguration,
+    configuration: OSSUtteranceConfiguration = .init()
+) async throws
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + speak(_:voice:configuration:) + + + Asynchronous + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Speaks attributed text using a resolved AVFoundation voice.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public func speak(
+    _ attributedText: NSAttributedString,
+    voice: OSSVoiceConfiguration,
+    configuration: OSSUtteranceConfiguration = .init()
+) async throws
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + pauseSpeaking() + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Pauses the current utterance immediately when the engine is speaking.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public func pauseSpeaking()
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + continueSpeaking() + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Resumes a paused utterance.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public func continueSpeaking()
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + stopSpeaking() + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Stops the current utterance and finishes the synthesis operation.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public func stopSpeaking()
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + recognitionEvents(locale:requestAuthorization:) + + + Asynchronous + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Starts recognition and returns a stream that owns the recording session. +Cancelling iteration tears down the audio tap and recognition task.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public func recognitionEvents(
+    locale: Locale,
+    requestAuthorization: Bool = true
+) async throws -> AsyncThrowingStream<OSSSpeechRecognitionEvent, Error>
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + cancelRecognition() + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Cancels the active recognition session and tears down audio recording.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            @MainActor
+public func cancelRecognition()
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Completes the awaiting synthesis operation when AVFoundation finishes speaking.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            nonisolated public func speechSynthesizer(
+    _ synthesizer: AVSpeechSynthesizer,
+    didFinish utterance: AVSpeechUtterance
+)
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Completes the awaiting synthesis operation with cancellation when speech is cancelled.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            nonisolated public func speechSynthesizer(
+    _ synthesizer: AVSpeechSynthesizer,
+    didCancel utterance: AVSpeechUtterance
+)
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            Emits recognizer availability changes to the active recognition stream.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            nonisolated public func speechRecognizer(
+    _ speechRecognizer: SFSpeechRecognizer,
+    availabilityDidChange available: Bool
+)
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          + + diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeechEngine/State.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeechEngine/State.html new file mode 100644 index 0000000..a66b73d --- /dev/null +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeechEngine/State.html @@ -0,0 +1,229 @@ + + + + State Enumeration Reference + + + + + + + + + + + + + +
                                                                                                          +
                                                                                                          +

                                                                                                          OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                          +

                                                                                                          GitHubView on GitHub

                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                          +

                                                                                                          State

                                                                                                          +
                                                                                                          +
                                                                                                          + + 
                                                                                                          public enum State : Equatable
                                                                                                          + +
                                                                                                          +
                                                                                                          +

                                                                                                          Current high-level activity of the speech engine.

                                                                                                          + +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                            +
                                                                                                          • +
                                                                                                            + + + + idle + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            The engine is not speaking or listening.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            case idle
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + speaking + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            The engine is currently synthesizing speech.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            case speaking
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          • +
                                                                                                            + + + + listening + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +

                                                                                                            The engine is currently recording and recognizing speech.

                                                                                                            + +
                                                                                                            +
                                                                                                            +

                                                                                                            Declaration

                                                                                                            +
                                                                                                            +

                                                                                                            Swift

                                                                                                            + 
                                                                                                            case listening
                                                                                                            + +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            +
                                                                                                            • +
                                                                                                          +
                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          + + diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeechUtility.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeechUtility.html index 06956c8..a5e5b1e 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeechUtility.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSSpeechUtility.html @@ -8,20 +8,28 @@ + + +
                                                                                                          -

                                                                                                          OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                          -

                                                                                                          View on GitHub

                                                                                                          +

                                                                                                          OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                          +

                                                                                                          GitHubView on GitHub

                                                                                                          +
                                                                                                          +
                                                                                                          + +
                                                                                                          +
                                                                                                          @@ -34,6 +42,12 @@
                                                                                                        • OSSSpeech
                                                                                                          • +
                                                                                                        • + OSSSpeechEngine +
                                                                                                          • +
                                                                                                        • + – State +
                                                                                                        • OSSSpeechUtility
                                                                                                          • @@ -48,12 +62,18 @@
                                                                                                        • Enumerations
                                                                                                        @@ -151,7 +178,7 @@

                                                                                                        Declaration

                                                                                                        -

                                                                                                        Public Methods

                                                                                                        +

                                                                                                        Public Methods

                                                                                                        @@ -227,11 +254,10 @@

                                                                                                        Return Value

                                                                                                        - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSUtterance.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSUtterance.html index 5d1a0f4..c6e4f64 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSUtterance.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSUtterance.html @@ -8,20 +8,28 @@ + + +
                                                                                                        -

                                                                                                        OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                        -

                                                                                                        View on GitHub

                                                                                                        +

                                                                                                        OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                        +

                                                                                                        GitHubView on GitHub

                                                                                                        +
                                                                                                        +
                                                                                                        + +
                                                                                                        +
                                                                                                        @@ -34,6 +42,12 @@
                                                                                                      • OSSSpeech
                                                                                                        • +
                                                                                                      • + OSSSpeechEngine +
                                                                                                        • +
                                                                                                      • + – State +
                                                                                                      • OSSSpeechUtility
                                                                                                        • @@ -48,12 +62,18 @@
                                                                                                      • Enumerations
                                                                                                          +
                                                                                                        • + OSSSpeechError +
                                                                                                        • OSSSpeechKitAuthorizationStatus
                                                                                                        • OSSSpeechKitErrorType
                                                                                                          • +
                                                                                                        • + OSSSpeechRecognitionEvent +
                                                                                                        • OSSSpeechRecognitionTaskType
                                                                                                          • @@ -65,9 +85,6 @@
                                                                                                        • Extensions
                                                                                                            -
                                                                                                          • - Bundle -
                                                                                                          • NSObject
                                                                                                            • @@ -84,6 +101,15 @@
                                                                                                          • Structures
                                                                                                              +
                                                                                                            • + OSSLanguage +
                                                                                                              • +
                                                                                                            • + OSSUtteranceConfiguration +
                                                                                                              • +
                                                                                                            • + OSSVoiceConfiguration +
                                                                                                            • OSSVoiceInfo
                                                                                                              • @@ -97,7 +123,9 @@

                                                                                                              OSSUtterance

                                                                                                              - 
                                                                                                              public class OSSUtterance : AVSpeechUtterance
                                                                                                              + + 
                                                                                                              @available(*, deprecated, message: "Use OSSUtteranceConfiguration with OSSSpeechEngine.")
+public class OSSUtterance : AVSpeechUtterance
                                                                                                              @@ -115,7 +143,7 @@

                                                                                                              OSSUtterance

                                                                                                              -

                                                                                                              Variables

                                                                                                              +

                                                                                                              Variables

                                                                                                              @@ -188,7 +216,7 @@

                                                                                                              Declaration

                                                                                                              -

                                                                                                              Lifecycle

                                                                                                              +

                                                                                                              Lifecycle

                                                                                                              @@ -206,7 +234,10 @@

                                                                                                              Lifecycle

                                                                                                              -

                                                                                                              Undocumented

                                                                                                              +

                                                                                                              Creates an error placeholder utterance.

                                                                                                              + +

                                                                                                              Use init(string:) or init(attributedString:) to create a useful +utterance.

                                                                                                              @@ -306,11 +337,10 @@

                                                                                                              Declaration

                                                                                                              - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSVoice.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSVoice.html index ab77adc..7430319 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSVoice.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Classes/OSSVoice.html @@ -8,20 +8,28 @@ + + +
                                                                                                              -

                                                                                                              OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                              -

                                                                                                              View on GitHub

                                                                                                              +

                                                                                                              OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                              +

                                                                                                              GitHubView on GitHub

                                                                                                              +
                                                                                                              +
                                                                                                              + +
                                                                                                              +
                                                                                                              @@ -34,6 +42,12 @@
                                                                                                            • OSSSpeech
                                                                                                              • +
                                                                                                            • + OSSSpeechEngine +
                                                                                                              • +
                                                                                                            • + – State +
                                                                                                            • OSSSpeechUtility
                                                                                                              • @@ -48,12 +62,18 @@
                                                                                                            • Enumerations
                                                                                                                +
                                                                                                              • + OSSSpeechError +
                                                                                                              • OSSSpeechKitAuthorizationStatus
                                                                                                              • OSSSpeechKitErrorType
                                                                                                                • +
                                                                                                              • + OSSSpeechRecognitionEvent +
                                                                                                              • OSSSpeechRecognitionTaskType
                                                                                                                • @@ -65,9 +85,6 @@
                                                                                                              • Extensions
                                                                                                                  -
                                                                                                                • - Bundle -
                                                                                                                • NSObject
                                                                                                                  • @@ -84,6 +101,15 @@
                                                                                                                • Structures
                                                                                                                    +
                                                                                                                  • + OSSLanguage +
                                                                                                                    • +
                                                                                                                  • + OSSUtteranceConfiguration +
                                                                                                                    • +
                                                                                                                  • + OSSVoiceConfiguration +
                                                                                                                  • OSSVoiceInfo
                                                                                                                    • @@ -97,8 +123,9 @@

                                                                                                                    OSSVoice

                                                                                                                    - 
                                                                                                                    @available(iOS 9.0, *)
-public class OSSVoice : AVSpeechSynthesisVoice
                                                                                                                    + + 
                                                                                                                    @available(*, deprecated, message: "Use OSSVoiceConfiguration, which resolves a real AVSpeechSynthesisVoice.")
+public class OSSVoice : AVSpeechSynthesisVoice, @unchecked Sendable
                                                                                                                    @@ -121,7 +148,7 @@

                                                                                                                    OSSVoice

                                                                                                                    -

                                                                                                                    Private Properties

                                                                                                                    +

                                                                                                                    Private Properties

                                                                                                                    @@ -299,11 +326,10 @@

                                                                                                                    Declaration

                                                                                                                    - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums.html index aa240fd..8fabd61 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums.html @@ -8,20 +8,28 @@ + + +
                                                                                                                    -

                                                                                                                    OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                                    -

                                                                                                                    View on GitHub

                                                                                                                    +

                                                                                                                    OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                    +

                                                                                                                    GitHubView on GitHub

                                                                                                                    +
                                                                                                                    +
                                                                                                                    + +
                                                                                                                    +
                                                                                                                    @@ -34,6 +42,12 @@
                                                                                                                  • OSSSpeech
                                                                                                                    • +
                                                                                                                  • + OSSSpeechEngine +
                                                                                                                    • +
                                                                                                                  • + – State +
                                                                                                                  • OSSSpeechUtility
                                                                                                                    • @@ -48,12 +62,18 @@
                                                                                                                  • Enumerations
                                                                                                                      +
                                                                                                                    • + OSSSpeechError +
                                                                                                                    • OSSSpeechKitAuthorizationStatus
                                                                                                                    • OSSSpeechKitErrorType
                                                                                                                      • +
                                                                                                                    • + OSSSpeechRecognitionEvent +
                                                                                                                    • OSSSpeechRecognitionTaskType
                                                                                                                      • @@ -65,9 +85,6 @@
                                                                                                                    • Extensions
                                                                                                                        -
                                                                                                                      • - Bundle -
                                                                                                                      • NSObject
                                                                                                                        • @@ -84,6 +101,15 @@
                                                                                                                      • Structures
                                                                                                                          +
                                                                                                                        • + OSSLanguage +
                                                                                                                          • +
                                                                                                                        • + OSSUtteranceConfiguration +
                                                                                                                          • +
                                                                                                                        • + OSSVoiceConfiguration +
                                                                                                                        • OSSVoiceInfo
                                                                                                                          • @@ -101,6 +127,39 @@

                                                                                                                          Enumerations

                                                                                                                            +
                                                                                                                          • +
                                                                                                                            + + + + OSSVoiceEnum + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            The available system voices.

                                                                                                                            + +

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

                                                                                                                            +
                                                                                                                            OSSVoiceEnum.allCases
+
                                                                                                                            + + See more +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Declaration

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Swift

                                                                                                                            + 
                                                                                                                            @available(*, deprecated, message: "Use OSSLanguage.catalog and runtime capability APIs.")
+public enum OSSVoiceEnum : String, CaseIterable
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                          • @@ -188,9 +247,9 @@

                                                                                                                            Declaration

                                                                                                                          • @@ -198,19 +257,43 @@

                                                                                                                            Declaration

                                                                                                                            -

                                                                                                                            The available system voices.

                                                                                                                            +

                                                                                                                            Typed failures emitted by the modern OSSSpeechKit API.

                                                                                                                            -

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

                                                                                                                            -
                                                                                                                            OSSVoiceEnum.allCases
-
                                                                                                                            + See more +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Declaration

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Swift

                                                                                                                            + 
                                                                                                                            public enum OSSSpeechError : Error, LocalizedError
                                                                                                                            - See more +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            • +
                                                                                                                          • + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Events from a live recognition session.

                                                                                                                            + + See more

                                                                                                                            Declaration

                                                                                                                            Swift

                                                                                                                            - 
                                                                                                                            public enum OSSVoiceEnum : String, CaseIterable
                                                                                                                            + 
                                                                                                                            public enum OSSSpeechRecognitionEvent
                                                                                                                            @@ -222,11 +305,10 @@

                                                                                                                            Declaration

                                                                                                                          - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechError.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechError.html new file mode 100644 index 0000000..3adde59 --- /dev/null +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechError.html @@ -0,0 +1,390 @@ + + + + OSSSpeechError Enumeration Reference + + + + + + + + + + + + + +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                          +

                                                                                                                          GitHubView on GitHub

                                                                                                                          +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          OSSSpeechError

                                                                                                                          +
                                                                                                                          +
                                                                                                                          + + 
                                                                                                                          public enum OSSSpeechError : Error, LocalizedError
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          Typed failures emitted by the modern OSSSpeechKit API.

                                                                                                                          + +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                            +
                                                                                                                          • +
                                                                                                                            + + + + emptyText + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            The provided speech text was empty or only whitespace.

                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Declaration

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Swift

                                                                                                                            + 
                                                                                                                            case emptyText
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            • +
                                                                                                                          • + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            No installed speech synthesis voice matched the requested locale.

                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Declaration

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Swift

                                                                                                                            + 
                                                                                                                            case voiceUnavailable(localeIdentifier: String)
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            • +
                                                                                                                          • + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Speech recognition authorization was denied or unavailable.

                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Declaration

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Swift

                                                                                                                            + 
                                                                                                                            case speechAuthorizationDenied
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            • +
                                                                                                                          • + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Microphone recording authorization was denied or unavailable.

                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Declaration

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Swift

                                                                                                                            + 
                                                                                                                            case microphoneAuthorizationDenied
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            • +
                                                                                                                          • + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Speech recognition does not support the requested locale on this device.

                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Declaration

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Swift

                                                                                                                            + 
                                                                                                                            case recognitionLocaleUnsupported(String)
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            • +
                                                                                                                          • +
                                                                                                                            + + + + recognizerUnavailable + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            The speech recognizer exists but is not currently available.

                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Declaration

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Swift

                                                                                                                            + 
                                                                                                                            case recognizerUnavailable
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            • +
                                                                                                                          • + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            AVFoundation could not configure or start the audio engine/session.

                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Declaration

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Swift

                                                                                                                            + 
                                                                                                                            case audioEngineFailure(underlying: Error?)
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            • +
                                                                                                                          • +
                                                                                                                            + + + + operationInProgress + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            A speech synthesis or recognition operation is already active.

                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Declaration

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Swift

                                                                                                                            + 
                                                                                                                            case operationInProgress
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            • +
                                                                                                                          • +
                                                                                                                            + + + + errorDescription + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +

                                                                                                                            Declaration

                                                                                                                            +
                                                                                                                            +

                                                                                                                            Swift

                                                                                                                            + 
                                                                                                                            public var errorDescription: String? { get }
                                                                                                                            + +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            +
                                                                                                                            • +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          + + diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechKitAuthorizationStatus.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechKitAuthorizationStatus.html index 5fa4339..e474088 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechKitAuthorizationStatus.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechKitAuthorizationStatus.html @@ -8,20 +8,28 @@ + + +
                                                                                                                          -

                                                                                                                          OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                                          -

                                                                                                                          View on GitHub

                                                                                                                          +

                                                                                                                          OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                          +

                                                                                                                          GitHubView on GitHub

                                                                                                                          +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          @@ -34,6 +42,12 @@
                                                                                                                        • OSSSpeech
                                                                                                                          • +
                                                                                                                        • + OSSSpeechEngine +
                                                                                                                          • +
                                                                                                                        • + – State +
                                                                                                                        • OSSSpeechUtility
                                                                                                                          • @@ -48,12 +62,18 @@
                                                                                                                        • Enumerations
                                                                                                                            +
                                                                                                                          • + OSSSpeechError +
                                                                                                                          • OSSSpeechKitAuthorizationStatus
                                                                                                                          • OSSSpeechKitErrorType
                                                                                                                            • +
                                                                                                                          • + OSSSpeechRecognitionEvent +
                                                                                                                          • OSSSpeechRecognitionTaskType
                                                                                                                            • @@ -65,9 +85,6 @@
                                                                                                                          • Extensions
                                                                                                                              -
                                                                                                                            • - Bundle -
                                                                                                                            • NSObject
                                                                                                                              • @@ -84,6 +101,15 @@
                                                                                                                            • Structures
                                                                                                                                +
                                                                                                                              • + OSSLanguage +
                                                                                                                                • +
                                                                                                                              • + OSSUtteranceConfiguration +
                                                                                                                                • +
                                                                                                                              • + OSSVoiceConfiguration +
                                                                                                                              • OSSVoiceInfo
                                                                                                                                • @@ -97,6 +123,7 @@

                                                                                                                                OSSSpeechKitAuthorizationStatus

                                                                                                                                + 
                                                                                                                                public enum OSSSpeechKitAuthorizationStatus : Int
                                                                                                                                @@ -247,11 +274,10 @@

                                                                                                                                Declaration

                                                                                                                                - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechKitErrorType.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechKitErrorType.html index 85b8383..656d6f8 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechKitErrorType.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechKitErrorType.html @@ -8,20 +8,28 @@ + + +
                                                                                                                                -

                                                                                                                                OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                                                -

                                                                                                                                View on GitHub

                                                                                                                                +

                                                                                                                                OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                +

                                                                                                                                GitHubView on GitHub

                                                                                                                                +
                                                                                                                                +
                                                                                                                                + +
                                                                                                                                +
                                                                                                                                @@ -34,6 +42,12 @@
                                                                                                                              • OSSSpeech
                                                                                                                                • +
                                                                                                                              • + OSSSpeechEngine +
                                                                                                                                • +
                                                                                                                              • + – State +
                                                                                                                              • OSSSpeechUtility
                                                                                                                                • @@ -48,12 +62,18 @@
                                                                                                                              • Enumerations
                                                                                                                                  +
                                                                                                                                • + OSSSpeechError +
                                                                                                                                • OSSSpeechKitAuthorizationStatus
                                                                                                                                • OSSSpeechKitErrorType
                                                                                                                                  • +
                                                                                                                                • + OSSSpeechRecognitionEvent +
                                                                                                                                • OSSSpeechRecognitionTaskType
                                                                                                                                  • @@ -65,9 +85,6 @@
                                                                                                                                • Extensions
                                                                                                                                    -
                                                                                                                                  • - Bundle -
                                                                                                                                  • NSObject
                                                                                                                                    • @@ -84,6 +101,15 @@
                                                                                                                                  • Structures
                                                                                                                                      +
                                                                                                                                    • + OSSLanguage +
                                                                                                                                      • +
                                                                                                                                    • + OSSUtteranceConfiguration +
                                                                                                                                      • +
                                                                                                                                    • + OSSVoiceConfiguration +
                                                                                                                                    • OSSVoiceInfo
                                                                                                                                      • @@ -97,6 +123,7 @@

                                                                                                                                      OSSSpeechKitErrorType

                                                                                                                                      + 
                                                                                                                                      public enum OSSSpeechKitErrorType : Int
                                                                                                                                      @@ -386,11 +413,10 @@

                                                                                                                                      Declaration

                                                                                                                                      - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechRecognitionEvent.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechRecognitionEvent.html new file mode 100644 index 0000000..7a5a6d2 --- /dev/null +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechRecognitionEvent.html @@ -0,0 +1,256 @@ + + + + OSSSpeechRecognitionEvent Enumeration Reference + + + + + + + + + + + + + +
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                      +

                                                                                                                                      GitHubView on GitHub

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      OSSSpeechRecognitionEvent

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + + 
                                                                                                                                      public enum OSSSpeechRecognitionEvent
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      +

                                                                                                                                      Events from a live recognition session.

                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                        +
                                                                                                                                      • +
                                                                                                                                        + + + + partial(_:) + +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Interim transcription text emitted before recognition completes.

                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Declaration

                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Swift

                                                                                                                                        + 
                                                                                                                                        case partial(String)
                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        • +
                                                                                                                                      • +
                                                                                                                                        + + + + completed(_:) + +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Final transcription text emitted when recognition completes.

                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Declaration

                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Swift

                                                                                                                                        + 
                                                                                                                                        case completed(String)
                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        • +
                                                                                                                                      • + +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Availability updates reported by the underlying speech recognizer.

                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Declaration

                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Swift

                                                                                                                                        + 
                                                                                                                                        case availabilityChanged(Bool)
                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        • +
                                                                                                                                      • +
                                                                                                                                        + + + + cancelled + +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Recognition was cancelled before producing a final result.

                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Declaration

                                                                                                                                        +
                                                                                                                                        +

                                                                                                                                        Swift

                                                                                                                                        + 
                                                                                                                                        case cancelled
                                                                                                                                        + +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        +
                                                                                                                                        • +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      + + diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechRecognitionTaskType.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechRecognitionTaskType.html index 188aa7a..6b12f60 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechRecognitionTaskType.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSSpeechRecognitionTaskType.html @@ -8,20 +8,28 @@ + + +
                                                                                                                                      -

                                                                                                                                      OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                                                      -

                                                                                                                                      View on GitHub

                                                                                                                                      +

                                                                                                                                      OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                      +

                                                                                                                                      GitHubView on GitHub

                                                                                                                                      +
                                                                                                                                      +
                                                                                                                                      + +
                                                                                                                                      +
                                                                                                                                      @@ -34,6 +42,12 @@
                                                                                                                                    • OSSSpeech
                                                                                                                                      • +
                                                                                                                                    • + OSSSpeechEngine +
                                                                                                                                      • +
                                                                                                                                    • + – State +
                                                                                                                                    • OSSSpeechUtility
                                                                                                                                      • @@ -48,12 +62,18 @@
                                                                                                                                    • Enumerations
                                                                                                                                        +
                                                                                                                                      • + OSSSpeechError +
                                                                                                                                      • OSSSpeechKitAuthorizationStatus
                                                                                                                                      • OSSSpeechKitErrorType
                                                                                                                                        • +
                                                                                                                                      • + OSSSpeechRecognitionEvent +
                                                                                                                                      • OSSSpeechRecognitionTaskType
                                                                                                                                        • @@ -65,9 +85,6 @@
                                                                                                                                      • Extensions
                                                                                                                                          -
                                                                                                                                        • - Bundle -
                                                                                                                                        • NSObject
                                                                                                                                          • @@ -84,6 +101,15 @@
                                                                                                                                        • Structures
                                                                                                                                            +
                                                                                                                                          • + OSSLanguage +
                                                                                                                                            • +
                                                                                                                                          • + OSSUtteranceConfiguration +
                                                                                                                                            • +
                                                                                                                                          • + OSSVoiceConfiguration +
                                                                                                                                          • OSSVoiceInfo
                                                                                                                                            • @@ -97,6 +123,7 @@

                                                                                                                                            OSSSpeechRecognitionTaskType

                                                                                                                                            + 
                                                                                                                                            public enum OSSSpeechRecognitionTaskType : Int
                                                                                                                                            @@ -249,11 +276,10 @@

                                                                                                                                            Declaration

                                                                                                                                            - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSVoiceEnum.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSVoiceEnum.html index 88eec06..5e3755d 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSVoiceEnum.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Enums/OSSVoiceEnum.html @@ -8,20 +8,28 @@ + + +
                                                                                                                                            -

                                                                                                                                            OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                                                            -

                                                                                                                                            View on GitHub

                                                                                                                                            +

                                                                                                                                            OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                            +

                                                                                                                                            GitHubView on GitHub

                                                                                                                                            +
                                                                                                                                            +
                                                                                                                                            + +
                                                                                                                                            +
                                                                                                                                            @@ -34,6 +42,12 @@
                                                                                                                                          • OSSSpeech
                                                                                                                                            • +
                                                                                                                                          • + OSSSpeechEngine +
                                                                                                                                            • +
                                                                                                                                          • + – State +
                                                                                                                                          • OSSSpeechUtility
                                                                                                                                            • @@ -48,12 +62,18 @@
                                                                                                                                          • Enumerations
                                                                                                                                              +
                                                                                                                                            • + OSSSpeechError +
                                                                                                                                            • OSSSpeechKitAuthorizationStatus
                                                                                                                                            • OSSSpeechKitErrorType
                                                                                                                                              • +
                                                                                                                                            • + OSSSpeechRecognitionEvent +
                                                                                                                                            • OSSSpeechRecognitionTaskType
                                                                                                                                              • @@ -65,9 +85,6 @@
                                                                                                                                            • Extensions
                                                                                                                                                -
                                                                                                                                              • - Bundle -
                                                                                                                                              • NSObject
                                                                                                                                                • @@ -84,6 +101,15 @@
                                                                                                                                              • Structures
                                                                                                                                                  +
                                                                                                                                                • + OSSLanguage +
                                                                                                                                                  • +
                                                                                                                                                • + OSSUtteranceConfiguration +
                                                                                                                                                  • +
                                                                                                                                                • + OSSVoiceConfiguration +
                                                                                                                                                • OSSVoiceInfo
                                                                                                                                                  • @@ -97,7 +123,9 @@

                                                                                                                                                  OSSVoiceEnum

                                                                                                                                                  - 
                                                                                                                                                  public enum OSSVoiceEnum : String, CaseIterable
                                                                                                                                                  + + 
                                                                                                                                                  @available(*, deprecated, message: "Use OSSLanguage.catalog and runtime capability APIs.")
+public enum OSSVoiceEnum : String, CaseIterable
                                                                                                                                                  @@ -165,6 +193,33 @@

                                                                                                                                                  Declaration

                                                                                                                                                  +
                                                                                                                                                • +
                                                                                                                                                  + + + + Bulgarian + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Bulgarian

                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Declaration

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Swift

                                                                                                                                                  + 
                                                                                                                                                  case Bulgarian = "bg-BG"
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                • @@ -205,7 +260,7 @@

                                                                                                                                                  Declaration

                                                                                                                                                  -

                                                                                                                                                  Chinese

                                                                                                                                                  +

                                                                                                                                                  Chinese Traditional

                                                                                                                                                  @@ -219,6 +274,33 @@

                                                                                                                                                  Declaration

                                                                                                                                                  • +
                                                                                                                                                • +
                                                                                                                                                  + + + + ChineseSimplified + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Chinese Simplified

                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Declaration

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Swift

                                                                                                                                                  + 
                                                                                                                                                  case ChineseSimplified = "zh-CN"
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                • @@ -246,6 +328,33 @@

                                                                                                                                                  Declaration

                                                                                                                                                  • +
                                                                                                                                                • +
                                                                                                                                                  + + + + Croatian + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Croatian

                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Declaration

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Swift

                                                                                                                                                  + 
                                                                                                                                                  case Croatian = "hr-HR"
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                • @@ -570,6 +679,33 @@

                                                                                                                                                  Declaration

                                                                                                                                                  • +
                                                                                                                                                • +
                                                                                                                                                  + + + + IndianEnglish + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Indian English

                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Declaration

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Swift

                                                                                                                                                  + 
                                                                                                                                                  case IndianEnglish = "en-IN"
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                • @@ -705,6 +841,33 @@

                                                                                                                                                  Declaration

                                                                                                                                                  • +
                                                                                                                                                • +
                                                                                                                                                  + + + + Malay + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Malaysian

                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Declaration

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Swift

                                                                                                                                                  + 
                                                                                                                                                  case Malay = "ms-MY"
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                • @@ -759,6 +922,33 @@

                                                                                                                                                  Declaration

                                                                                                                                                  • +
                                                                                                                                                • +
                                                                                                                                                  + + + + NorwegianBokmal + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Norwegian Bokmal

                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Declaration

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Swift

                                                                                                                                                  + 
                                                                                                                                                  case NorwegianBokmal = "nb-NO"
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                • @@ -975,6 +1165,33 @@

                                                                                                                                                  Declaration

                                                                                                                                                  • +
                                                                                                                                                • +
                                                                                                                                                  + + + + SpanishCatalan + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Catalan

                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Declaration

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Swift

                                                                                                                                                  + 
                                                                                                                                                  case SpanishCatalan = "ca-ES"
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                • @@ -1083,6 +1300,33 @@

                                                                                                                                                  Declaration

                                                                                                                                                  • +
                                                                                                                                                • +
                                                                                                                                                  + + + + Ukranian + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Ukranian

                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Declaration

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Swift

                                                                                                                                                  + 
                                                                                                                                                  case Ukranian = "uk-UA"
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                • @@ -1110,6 +1354,60 @@

                                                                                                                                                  Declaration

                                                                                                                                                  • +
                                                                                                                                                • +
                                                                                                                                                  + + + + Vietnamese + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Vietnamese

                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Declaration

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Swift

                                                                                                                                                  + 
                                                                                                                                                  case Vietnamese = "vi-VN"
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  • +
                                                                                                                                                • +
                                                                                                                                                  + + + + ArabicWorld + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Arabic World

                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Declaration

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Swift

                                                                                                                                                  + 
                                                                                                                                                  case ArabicWorld = "ar-001"
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                • @@ -1204,9 +1502,9 @@

                                                                                                                                                  Declaration

                                                                                                                                                  -

                                                                                                                                                  The flag for the selected language.

                                                                                                                                                  +

                                                                                                                                                  The legacy image flag for the selected language.

                                                                                                                                                  -

                                                                                                                                                  You can supply your own flag image, provided is has the same name (.rawValue) as the image in the pod assets.

                                                                                                                                                  +

                                                                                                                                                  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.

                                                                                                                                                  @@ -1215,7 +1513,119 @@

                                                                                                                                                  Declaration

                                                                                                                                                  Declaration

                                                                                                                                                  Swift

                                                                                                                                                  - 
                                                                                                                                                  public var flag: UIImage? { get }
                                                                                                                                                  + 
                                                                                                                                                  @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 }
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  • +
                                                                                                                                                • +
                                                                                                                                                  + + + + languageMetadata + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Modern metadata corresponding to this legacy case.

                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Declaration

                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  Swift

                                                                                                                                                  + 
                                                                                                                                                  var languageMetadata: OSSLanguage { get }
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  • +
                                                                                                                                                • +
                                                                                                                                                  + + + + flagEmoji + +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  +

                                                                                                                                                  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
                                                                                                                                                  @@ -1227,11 +1637,10 @@

                                                                                                                                                  Declaration

                                                                                                                                                  - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Extensions.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Extensions.html index f3d2a87..92cf5e1 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Extensions.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Extensions.html @@ -8,20 +8,28 @@ + + +
                                                                                                                                                  -

                                                                                                                                                  OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                                                                  -

                                                                                                                                                  View on GitHub

                                                                                                                                                  +

                                                                                                                                                  OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                                  +

                                                                                                                                                  GitHubView on GitHub

                                                                                                                                                  +
                                                                                                                                                  +
                                                                                                                                                  + +
                                                                                                                                                  +
                                                                                                                                                  @@ -34,6 +42,12 @@
                                                                                                                                                • OSSSpeech
                                                                                                                                                  • +
                                                                                                                                                • + OSSSpeechEngine +
                                                                                                                                                  • +
                                                                                                                                                • + – State +
                                                                                                                                                • OSSSpeechUtility
                                                                                                                                                  • @@ -48,12 +62,18 @@
                                                                                                                                                • Enumerations
                                                                                                                                                    +
                                                                                                                                                  • + OSSSpeechError +
                                                                                                                                                  • OSSSpeechKitAuthorizationStatus
                                                                                                                                                  • OSSSpeechKitErrorType
                                                                                                                                                    • +
                                                                                                                                                  • + OSSSpeechRecognitionEvent +
                                                                                                                                                  • OSSSpeechRecognitionTaskType
                                                                                                                                                    • @@ -65,9 +85,6 @@
                                                                                                                                                  • Extensions
                                                                                                                                                      -
                                                                                                                                                    • - Bundle -
                                                                                                                                                    • NSObject
                                                                                                                                                      • @@ -84,6 +101,15 @@
                                                                                                                                                    • Structures - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Extensions/Bundle.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Extensions/Bundle.html deleted file mode 100644 index 506d3dd..0000000 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Extensions/Bundle.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - Bundle Extension Reference - - - - - - - - - - -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                                                                      -

                                                                                                                                                      View on GitHub

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Bundle

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - 
                                                                                                                                                      extension Bundle
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Bundle extension to aid in retrieving the SDK resources for getting SDK images.

                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • -
                                                                                                                                                        - - - - getResourcesBundle() - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Will return the Bundle for the SDK if it can be found.

                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Declaration

                                                                                                                                                        -
                                                                                                                                                        -

                                                                                                                                                        Swift

                                                                                                                                                        - 
                                                                                                                                                        static func getResourcesBundle() -> Bundle?
                                                                                                                                                        - -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        -
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - - - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Extensions/NSObject.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Extensions/NSObject.html index e408c3c..69e7cc9 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Extensions/NSObject.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Extensions/NSObject.html @@ -8,20 +8,28 @@ + + +
                                                                                                                                                      -

                                                                                                                                                      OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                                                                      -

                                                                                                                                                      View on GitHub

                                                                                                                                                      +

                                                                                                                                                      OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                                      +

                                                                                                                                                      GitHubView on GitHub

                                                                                                                                                      +
                                                                                                                                                      +
                                                                                                                                                      + +
                                                                                                                                                      +
                                                                                                                                                      @@ -34,6 +42,12 @@
                                                                                                                                                    • OSSSpeech
                                                                                                                                                      • +
                                                                                                                                                    • + OSSSpeechEngine +
                                                                                                                                                      • +
                                                                                                                                                    • + – State +
                                                                                                                                                    • OSSSpeechUtility
                                                                                                                                                      • @@ -48,12 +62,18 @@
                                                                                                                                                    • Enumerations
                                                                                                                                                        +
                                                                                                                                                      • + OSSSpeechError +
                                                                                                                                                      • OSSSpeechKitAuthorizationStatus
                                                                                                                                                      • OSSSpeechKitErrorType
                                                                                                                                                        • +
                                                                                                                                                      • + OSSSpeechRecognitionEvent +
                                                                                                                                                      • OSSSpeechRecognitionTaskType
                                                                                                                                                        • @@ -65,9 +85,6 @@
                                                                                                                                                      • Extensions
                                                                                                                                                          -
                                                                                                                                                        • - Bundle -
                                                                                                                                                        • NSObject
                                                                                                                                                          • @@ -84,6 +101,15 @@
                                                                                                                                                        • Structures
                                                                                                                                                            +
                                                                                                                                                          • + OSSLanguage +
                                                                                                                                                            • +
                                                                                                                                                          • + OSSUtteranceConfiguration +
                                                                                                                                                            • +
                                                                                                                                                          • + OSSVoiceConfiguration +
                                                                                                                                                          • OSSVoiceInfo
                                                                                                                                                            • @@ -97,6 +123,7 @@

                                                                                                                                                            NSObject

                                                                                                                                                            + 
                                                                                                                                                            extension NSObject
                                                                                                                                                            @@ -128,7 +155,8 @@

                                                                                                                                                            NSObject

                                                                                                                                                            Declaration

                                                                                                                                                            Swift

                                                                                                                                                            - 
                                                                                                                                                            public func debugLog(object: Any, functionName: String = #function, fileName: String = #file, lineNumber: Int = #line, message: String)
                                                                                                                                                            + 
                                                                                                                                                            @available(*, deprecated, message: "Use OSLog from your application instead.")
+public func debugLog(object: Any, functionName: String = #function, fileName: String = #file, lineNumber: Int = #line, message: String)
                                                                                                                                                            @@ -207,11 +235,10 @@

                                                                                                                                                            Parameters

                                                                                                                                                            - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Protocols.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Protocols.html index 308a45c..6a0424e 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Protocols.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Protocols.html @@ -8,20 +8,28 @@ + + +
                                                                                                                                                            -

                                                                                                                                                            OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                                                                            -

                                                                                                                                                            View on GitHub

                                                                                                                                                            +

                                                                                                                                                            OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                                            +

                                                                                                                                                            GitHubView on GitHub

                                                                                                                                                            +
                                                                                                                                                            +
                                                                                                                                                            + +
                                                                                                                                                            +
                                                                                                                                                            @@ -34,6 +42,12 @@
                                                                                                                                                          • OSSSpeech
                                                                                                                                                            • +
                                                                                                                                                          • + OSSSpeechEngine +
                                                                                                                                                            • +
                                                                                                                                                          • + – State +
                                                                                                                                                          • OSSSpeechUtility
                                                                                                                                                            • @@ -48,12 +62,18 @@
                                                                                                                                                          • Enumerations
                                                                                                                                                              +
                                                                                                                                                            • + OSSSpeechError +
                                                                                                                                                            • OSSSpeechKitAuthorizationStatus
                                                                                                                                                            • OSSSpeechKitErrorType
                                                                                                                                                              • +
                                                                                                                                                            • + OSSSpeechRecognitionEvent +
                                                                                                                                                            • OSSSpeechRecognitionTaskType
                                                                                                                                                              • @@ -65,9 +85,6 @@
                                                                                                                                                            • Extensions
                                                                                                                                                                -
                                                                                                                                                              • - Bundle -
                                                                                                                                                              • NSObject
                                                                                                                                                                • @@ -84,6 +101,15 @@
                                                                                                                                                              • Structures
                                                                                                                                                                  +
                                                                                                                                                                • + OSSLanguage +
                                                                                                                                                                  • +
                                                                                                                                                                • + OSSUtteranceConfiguration +
                                                                                                                                                                  • +
                                                                                                                                                                • + OSSVoiceConfiguration +
                                                                                                                                                                • OSSVoiceInfo
                                                                                                                                                                  • @@ -122,7 +148,8 @@

                                                                                                                                                                  Protocols

                                                                                                                                                                  Declaration

                                                                                                                                                                  Swift

                                                                                                                                                                  - 
                                                                                                                                                                  public protocol OSSSpeechDelegate : AnyObject
                                                                                                                                                                  + 
                                                                                                                                                                  @available(*, deprecated, message: "Use OSSSpeechEngine async methods and recognition events.")
+public protocol OSSSpeechDelegate : AnyObject
                                                                                                                                                                  @@ -134,11 +161,10 @@

                                                                                                                                                                  Declaration

                                                                                                                                                                  - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Protocols/OSSSpeechDelegate.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Protocols/OSSSpeechDelegate.html index 80bac84..26e7a5a 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Protocols/OSSSpeechDelegate.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Protocols/OSSSpeechDelegate.html @@ -8,20 +8,28 @@ + + +
                                                                                                                                                                  -

                                                                                                                                                                  OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                                                                                  -

                                                                                                                                                                  View on GitHub

                                                                                                                                                                  +

                                                                                                                                                                  OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                                                  +

                                                                                                                                                                  GitHubView on GitHub

                                                                                                                                                                  +
                                                                                                                                                                  +
                                                                                                                                                                  + +
                                                                                                                                                                  +
                                                                                                                                                                  @@ -34,6 +42,12 @@
                                                                                                                                                                • OSSSpeech
                                                                                                                                                                  • +
                                                                                                                                                                • + OSSSpeechEngine +
                                                                                                                                                                  • +
                                                                                                                                                                • + – State +
                                                                                                                                                                • OSSSpeechUtility
                                                                                                                                                                  • @@ -48,12 +62,18 @@
                                                                                                                                                                • Enumerations
                                                                                                                                                                    +
                                                                                                                                                                  • + OSSSpeechError +
                                                                                                                                                                  • OSSSpeechKitAuthorizationStatus
                                                                                                                                                                  • OSSSpeechKitErrorType
                                                                                                                                                                    • +
                                                                                                                                                                  • + OSSSpeechRecognitionEvent +
                                                                                                                                                                  • OSSSpeechRecognitionTaskType
                                                                                                                                                                    • @@ -65,9 +85,6 @@
                                                                                                                                                                  • Extensions
                                                                                                                                                                      -
                                                                                                                                                                    • - Bundle -
                                                                                                                                                                    • NSObject
                                                                                                                                                                      • @@ -84,6 +101,15 @@
                                                                                                                                                                    • Structures
                                                                                                                                                                        +
                                                                                                                                                                      • + OSSLanguage +
                                                                                                                                                                        • +
                                                                                                                                                                      • + OSSUtteranceConfiguration +
                                                                                                                                                                        • +
                                                                                                                                                                      • + OSSVoiceConfiguration +
                                                                                                                                                                      • OSSVoiceInfo
                                                                                                                                                                        • @@ -97,7 +123,9 @@

                                                                                                                                                                        OSSSpeechDelegate

                                                                                                                                                                        - 
                                                                                                                                                                        public protocol OSSSpeechDelegate : AnyObject
                                                                                                                                                                        + + 
                                                                                                                                                                        @available(*, deprecated, message: "Use OSSSpeechEngine async methods and recognition events.")
+public protocol OSSSpeechDelegate : AnyObject
                                                                                                                                                                        @@ -247,11 +275,10 @@

                                                                                                                                                                        Declaration

                                                                                                                                                                        - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs.html index 51f9549..a58eb0a 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs.html @@ -8,20 +8,28 @@ + + +
                                                                                                                                                                        -

                                                                                                                                                                        OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                                                                                        -

                                                                                                                                                                        View on GitHub

                                                                                                                                                                        +

                                                                                                                                                                        OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                                                        +

                                                                                                                                                                        GitHubView on GitHub

                                                                                                                                                                        +
                                                                                                                                                                        +
                                                                                                                                                                        + +
                                                                                                                                                                        +
                                                                                                                                                                        @@ -34,6 +42,12 @@
                                                                                                                                                                      • OSSSpeech
                                                                                                                                                                        • +
                                                                                                                                                                      • + OSSSpeechEngine +
                                                                                                                                                                        • +
                                                                                                                                                                      • + – State +
                                                                                                                                                                      • OSSSpeechUtility
                                                                                                                                                                        • @@ -48,12 +62,18 @@
                                                                                                                                                                      • Enumerations
                                                                                                                                                                          +
                                                                                                                                                                        • + OSSSpeechError +
                                                                                                                                                                        • OSSSpeechKitAuthorizationStatus
                                                                                                                                                                        • OSSSpeechKitErrorType
                                                                                                                                                                          • +
                                                                                                                                                                        • + OSSSpeechRecognitionEvent +
                                                                                                                                                                        • OSSSpeechRecognitionTaskType
                                                                                                                                                                          • @@ -65,9 +85,6 @@
                                                                                                                                                                        • Extensions
                                                                                                                                                                            -
                                                                                                                                                                          • - Bundle -
                                                                                                                                                                          • NSObject
                                                                                                                                                                            • @@ -84,6 +101,15 @@
                                                                                                                                                                          • Structures
                                                                                                                                                                              +
                                                                                                                                                                            • + OSSLanguage +
                                                                                                                                                                              • +
                                                                                                                                                                            • + OSSUtteranceConfiguration +
                                                                                                                                                                              • +
                                                                                                                                                                            • + OSSVoiceConfiguration +
                                                                                                                                                                            • OSSVoiceInfo
                                                                                                                                                                              • @@ -101,6 +127,95 @@

                                                                                                                                                                              Structures

                                                                                                                                                                                +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + OSSLanguage + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Display metadata for a language or regional voice supported by Apple platforms.

                                                                                                                                                                                + +

                                                                                                                                                                                The catalog is intentionally separate from runtime capabilities. Use +availableSynthesisVoices and supportsRecognition before presenting an +operation as available on the current device.

                                                                                                                                                                                + + See more +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public struct OSSLanguage : Hashable, Identifiable, Sendable
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + OSSVoiceConfiguration + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Selects an actual voice exposed by AVFoundation.

                                                                                                                                                                                + + See more +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public struct OSSVoiceConfiguration
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Value-style speech parameters used to construct a fresh AVFoundation +utterance for every synthesis request.

                                                                                                                                                                                + + See more +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public struct OSSUtteranceConfiguration
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                              • @@ -114,7 +229,7 @@

                                                                                                                                                                                Structures

                                                                                                                                                                                -

                                                                                                                                                                                The voice infor struct ensures that the data structure has conformity and consistency.

                                                                                                                                                                                +

                                                                                                                                                                                Information about a resolved system voice.

                                                                                                                                                                                See more
                                                                                                                                                                                @@ -122,7 +237,8 @@

                                                                                                                                                                                Structures

                                                                                                                                                                                Declaration

                                                                                                                                                                                Swift

                                                                                                                                                                                - 
                                                                                                                                                                                public struct OSSVoiceInfo
                                                                                                                                                                                + 
                                                                                                                                                                                @available(*, deprecated, message: "Use OSSLanguage and AVSpeechSynthesisVoice directly.")
+public struct OSSVoiceInfo
                                                                                                                                                                                @@ -134,11 +250,10 @@

                                                                                                                                                                                Declaration

                                                                                                                                                                              - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs/OSSLanguage.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs/OSSLanguage.html new file mode 100644 index 0000000..97e79d5 --- /dev/null +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs/OSSLanguage.html @@ -0,0 +1,586 @@ + + + + OSSLanguage Structure Reference + + + + + + + + + + + + + +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                                                              +

                                                                                                                                                                              GitHubView on GitHub

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              OSSLanguage

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + + 
                                                                                                                                                                              public struct OSSLanguage : Hashable, Identifiable, Sendable
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              Display metadata for a language or regional voice supported by Apple platforms.

                                                                                                                                                                              + +

                                                                                                                                                                              The catalog is intentionally separate from runtime capabilities. Use +availableSynthesisVoices and supportsRecognition before presenting an +operation as available on the current device.

                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                                +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + id + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Stable identifier used by OSSSpeechKit to refer to this catalog entry.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public let id: String
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + name + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Human-readable language or regional variant name for display.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public let name: String
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + locale + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Foundation locale that describes the language and region.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public let locale: Locale
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + regionCode + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Region override used when the locale alone cannot distinguish a variant.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public let regionCode: String?
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Voice identifiers that should be preferred when matching installed voices.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public let preferredVoiceIdentifiers: [String]
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Creates language metadata for the OSSSpeechKit catalog.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public init(
+    id: String,
+    name: String,
+    localeIdentifier: String,
+    regionCode: String? = nil,
+    preferredVoiceIdentifiers: [String] = []
+)
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Parameters

                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                + + id + + +
                                                                                                                                                                                +

                                                                                                                                                                                Stable catalog identifier.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + + name + + +
                                                                                                                                                                                +

                                                                                                                                                                                Human-readable display name.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + + localeIdentifier + + +
                                                                                                                                                                                +

                                                                                                                                                                                BCP 47 identifier for the language and region.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + + regionCode + + +
                                                                                                                                                                                +

                                                                                                                                                                                Optional region override for variants that share a locale.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + + preferredVoiceIdentifiers + + +
                                                                                                                                                                                +

                                                                                                                                                                                Preferred AVFoundation voice identifiers.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + localeIdentifier + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                The canonicalized BCP 47 identifier used for runtime capability checks.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public var localeIdentifier: String { get }
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Voices currently installed or exposed by the operating system.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public var availableSynthesisVoices: [AVSpeechSynthesisVoice] { get }
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + supportsRecognition + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Whether the legacy Speech recognizer reports this locale as supported.

                                                                                                                                                                                + +

                                                                                                                                                                                Support does not imply that Apple’s service is currently available.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public var supportsRecognition: Bool { get }
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Returns the exact supported recognition locale, or a same-language, +same-region canonical equivalent. It never silently changes regions.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public static func supportedRecognitionLocale(equivalentTo locale: Locale) -> Locale?
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + flagEmoji + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                A Unicode flag suitable for labels, SwiftUI Text, and accessibility.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                var flagEmoji: String { get }
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Renders flagEmoji to an image for UIKit clients that require one.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

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

                                                                                                                                                                                Curated languages and regional variants described by Apple’s current +VoiceOver and Dictation availability documentation.

                                                                                                                                                                                + +

                                                                                                                                                                                Availability still varies by OS release, device, installed assets, and +network access. Filter this catalog using the runtime capability APIs.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                static let catalog: [OSSLanguage]
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              + + diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs/OSSUtteranceConfiguration.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs/OSSUtteranceConfiguration.html new file mode 100644 index 0000000..26d8cf8 --- /dev/null +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs/OSSUtteranceConfiguration.html @@ -0,0 +1,384 @@ + + + + OSSUtteranceConfiguration Structure Reference + + + + + + + + + + + + + +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                                                              +

                                                                                                                                                                              GitHubView on GitHub

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              OSSUtteranceConfiguration

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + + 
                                                                                                                                                                              public struct OSSUtteranceConfiguration
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              Value-style speech parameters used to construct a fresh AVFoundation +utterance for every synthesis request.

                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                                +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + rate + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Speech rate to apply to the utterance.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public var rate: Float
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + pitchMultiplier + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Pitch multiplier to apply to the utterance.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public var pitchMultiplier: Float
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + volume + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Playback volume to apply to the utterance.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public var volume: Float
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + preUtteranceDelay + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Delay before the utterance begins speaking.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public var preUtteranceDelay: TimeInterval
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + postUtteranceDelay + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Delay after the utterance finishes speaking.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public var postUtteranceDelay: TimeInterval
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Creates speech synthesis parameters for an utterance.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public init(
+    rate: Float = AVSpeechUtteranceDefaultSpeechRate,
+    pitchMultiplier: Float = 1,
+    volume: Float = 1,
+    preUtteranceDelay: TimeInterval = 0,
+    postUtteranceDelay: TimeInterval = 0
+)
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Parameters

                                                                                                                                                                                + + + + + + + + + + + + + + + + + + + + + + + +
                                                                                                                                                                                + + rate + + +
                                                                                                                                                                                +

                                                                                                                                                                                Speech rate to apply.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + + pitchMultiplier + + +
                                                                                                                                                                                +

                                                                                                                                                                                Pitch multiplier to apply.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + + volume + + +
                                                                                                                                                                                +

                                                                                                                                                                                Playback volume to apply.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + + preUtteranceDelay + + +
                                                                                                                                                                                +

                                                                                                                                                                                Delay before speaking begins.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + + postUtteranceDelay + + +
                                                                                                                                                                                +

                                                                                                                                                                                Delay after speaking finishes.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              + + diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs/OSSVoiceConfiguration.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs/OSSVoiceConfiguration.html new file mode 100644 index 0000000..6759b6a --- /dev/null +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs/OSSVoiceConfiguration.html @@ -0,0 +1,331 @@ + + + + OSSVoiceConfiguration Structure Reference + + + + + + + + + + + + + +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                                                              +

                                                                                                                                                                              GitHubView on GitHub

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              OSSVoiceConfiguration

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + + 
                                                                                                                                                                              public struct OSSVoiceConfiguration
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +

                                                                                                                                                                              Selects an actual voice exposed by AVFoundation.

                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                                +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + language + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Language or regional variant used to search installed voices.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public var language: OSSLanguage
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + preferredIdentifier + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Specific AVFoundation voice identifier to prefer when available.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public var preferredIdentifier: String?
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + preferredQuality + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Preferred voice quality to use when multiple voices match the language.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public var preferredQuality: AVSpeechSynthesisVoiceQuality?
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Creates a voice selection request.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public init(
+    language: OSSLanguage,
+    preferredIdentifier: String? = nil,
+    preferredQuality: AVSpeechSynthesisVoiceQuality? = nil
+)
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Parameters

                                                                                                                                                                                + + + + + + + + + + + + + + + +
                                                                                                                                                                                + + language + + +
                                                                                                                                                                                +

                                                                                                                                                                                Language metadata used to find matching voices.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + + preferredIdentifier + + +
                                                                                                                                                                                +

                                                                                                                                                                                Optional exact AVFoundation voice identifier.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                + + preferredQuality + + +
                                                                                                                                                                                +

                                                                                                                                                                                Optional quality preference for matched voices.

                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              • +
                                                                                                                                                                                + + + + resolve() + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Resolves the best currently available system voice without relying on +AVFoundation’s silent cross-region fallback.

                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Declaration

                                                                                                                                                                                +
                                                                                                                                                                                +

                                                                                                                                                                                Swift

                                                                                                                                                                                + 
                                                                                                                                                                                public func resolve() -> AVSpeechSynthesisVoice?
                                                                                                                                                                                + +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                +
                                                                                                                                                                                • +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              + + diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs/OSSVoiceInfo.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs/OSSVoiceInfo.html index fab8c20..c619ff7 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs/OSSVoiceInfo.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/Structs/OSSVoiceInfo.html @@ -8,20 +8,28 @@ + + +
                                                                                                                                                                              -

                                                                                                                                                                              OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                                                                                              -

                                                                                                                                                                              View on GitHub

                                                                                                                                                                              +

                                                                                                                                                                              OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                                                              +

                                                                                                                                                                              GitHubView on GitHub

                                                                                                                                                                              +
                                                                                                                                                                              +
                                                                                                                                                                              + +
                                                                                                                                                                              +
                                                                                                                                                                              @@ -34,6 +42,12 @@
                                                                                                                                                                            • OSSSpeech
                                                                                                                                                                              • +
                                                                                                                                                                            • + OSSSpeechEngine +
                                                                                                                                                                              • +
                                                                                                                                                                            • + – State +
                                                                                                                                                                            • OSSSpeechUtility
                                                                                                                                                                              • @@ -48,12 +62,18 @@
                                                                                                                                                                            • Enumerations
                                                                                                                                                                                +
                                                                                                                                                                              • + OSSSpeechError +
                                                                                                                                                                              • OSSSpeechKitAuthorizationStatus
                                                                                                                                                                              • OSSSpeechKitErrorType
                                                                                                                                                                                • +
                                                                                                                                                                              • + OSSSpeechRecognitionEvent +
                                                                                                                                                                              • OSSSpeechRecognitionTaskType
                                                                                                                                                                                • @@ -65,9 +85,6 @@
                                                                                                                                                                              • Extensions
                                                                                                                                                                                  -
                                                                                                                                                                                • - Bundle -
                                                                                                                                                                                • NSObject
                                                                                                                                                                                  • @@ -84,6 +101,15 @@
                                                                                                                                                                                • Structures
                                                                                                                                                                                    +
                                                                                                                                                                                  • + OSSLanguage +
                                                                                                                                                                                    • +
                                                                                                                                                                                  • + OSSUtteranceConfiguration +
                                                                                                                                                                                    • +
                                                                                                                                                                                  • + OSSVoiceConfiguration +
                                                                                                                                                                                  • OSSVoiceInfo
                                                                                                                                                                                    • @@ -97,11 +123,13 @@

                                                                                                                                                                                    OSSVoiceInfo

                                                                                                                                                                                    - 
                                                                                                                                                                                    public struct OSSVoiceInfo
                                                                                                                                                                                    + + 
                                                                                                                                                                                    @available(*, deprecated, message: "Use OSSLanguage and AVSpeechSynthesisVoice directly.")
+public struct OSSVoiceInfo
                                                                                                                                                                                    -

                                                                                                                                                                                    The voice infor struct ensures that the data structure has conformity and consistency.

                                                                                                                                                                                    +

                                                                                                                                                                                    Information about a resolved system voice.

                                                                                                                                                                                    @@ -201,14 +229,42 @@

                                                                                                                                                                                    Declaration

                                                                                                                                                                                    -

                                                                                                                                                                                    Identifier is a unique bundle url provided by Apple for each AVSpeechSynthesisVoice.

                                                                                                                                                                                    +

                                                                                                                                                                                    Identifier is a unique bundle URL provided by Apple for each voice.

                                                                                                                                                                                    + +
                                                                                                                                                                                    +
                                                                                                                                                                                    +

                                                                                                                                                                                    Declaration

                                                                                                                                                                                    +
                                                                                                                                                                                    +

                                                                                                                                                                                    Swift

                                                                                                                                                                                    + 
                                                                                                                                                                                    @available(*, deprecated, message: "Use voiceIdentifier.")
+public var identifier: Any?
                                                                                                                                                                                    + +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    + + +
                                                                                                                                                                                  • +
                                                                                                                                                                                    + + + + voiceIdentifier + +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    +

                                                                                                                                                                                    Typed identifier for the resolved AVSpeechSynthesisVoice.

                                                                                                                                                                                    Declaration

                                                                                                                                                                                    Swift

                                                                                                                                                                                    - 
                                                                                                                                                                                    public var identifier: Any?
                                                                                                                                                                                    + 
                                                                                                                                                                                    public var voiceIdentifier: String?
                                                                                                                                                                                    @@ -220,11 +276,10 @@

                                                                                                                                                                                    Declaration

                                                                                                                                                                                    • - diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/css/highlight.css b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/css/highlight.css index d0db0e1..c170357 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/css/highlight.css +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/css/highlight.css @@ -1,200 +1,202 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ /* Credit to https://gist.github.com/wataru420/2048287 */ -.highlight { - /* Comment */ - /* Error */ - /* Keyword */ - /* Operator */ - /* Comment.Multiline */ - /* Comment.Preproc */ - /* Comment.Single */ - /* Comment.Special */ - /* Generic.Deleted */ - /* Generic.Deleted.Specific */ - /* Generic.Emph */ - /* Generic.Error */ - /* Generic.Heading */ - /* Generic.Inserted */ - /* Generic.Inserted.Specific */ - /* Generic.Output */ - /* Generic.Prompt */ - /* Generic.Strong */ - /* Generic.Subheading */ - /* Generic.Traceback */ - /* Keyword.Constant */ - /* Keyword.Declaration */ - /* Keyword.Pseudo */ - /* Keyword.Reserved */ - /* Keyword.Type */ - /* Literal.Number */ - /* Literal.String */ - /* Name.Attribute */ - /* Name.Builtin */ - /* Name.Class */ - /* Name.Constant */ - /* Name.Entity */ - /* Name.Exception */ - /* Name.Function */ - /* Name.Namespace */ - /* Name.Tag */ - /* Name.Variable */ - /* Operator.Word */ - /* Text.Whitespace */ - /* Literal.Number.Float */ - /* Literal.Number.Hex */ - /* Literal.Number.Integer */ - /* Literal.Number.Oct */ - /* Literal.String.Backtick */ - /* Literal.String.Char */ - /* Literal.String.Doc */ - /* Literal.String.Double */ - /* Literal.String.Escape */ - /* Literal.String.Heredoc */ - /* Literal.String.Interpol */ - /* Literal.String.Other */ - /* Literal.String.Regex */ - /* Literal.String.Single */ - /* Literal.String.Symbol */ - /* Name.Builtin.Pseudo */ - /* Name.Variable.Class */ - /* Name.Variable.Global */ - /* Name.Variable.Instance */ - /* Literal.Number.Integer.Long */ } - .highlight .c { - color: #999988; - font-style: italic; } - .highlight .err { - color: #a61717; - background-color: #e3d2d2; } - .highlight .k { - color: #000000; - font-weight: bold; } - .highlight .o { - color: #000000; - font-weight: bold; } - .highlight .cm { - color: #999988; - font-style: italic; } - .highlight .cp { - color: #999999; - font-weight: bold; } - .highlight .c1 { - color: #999988; - font-style: italic; } - .highlight .cs { - color: #999999; - font-weight: bold; - font-style: italic; } - .highlight .gd { - color: #000000; - background-color: #ffdddd; } - .highlight .gd .x { - color: #000000; - background-color: #ffaaaa; } - .highlight .ge { - color: #000000; - font-style: italic; } - .highlight .gr { - color: #aa0000; } - .highlight .gh { - color: #999999; } - .highlight .gi { - color: #000000; - background-color: #ddffdd; } - .highlight .gi .x { - color: #000000; - background-color: #aaffaa; } - .highlight .go { - color: #888888; } - .highlight .gp { - color: #555555; } - .highlight .gs { - font-weight: bold; } - .highlight .gu { - color: #aaaaaa; } - .highlight .gt { - color: #aa0000; } - .highlight .kc { - color: #000000; - font-weight: bold; } - .highlight .kd { - color: #000000; - font-weight: bold; } - .highlight .kp { - color: #000000; - font-weight: bold; } - .highlight .kr { - color: #000000; - font-weight: bold; } - .highlight .kt { - color: #445588; } - .highlight .m { - color: #009999; } - .highlight .s { - color: #d14; } - .highlight .na { - color: #008080; } - .highlight .nb { - color: #0086B3; } - .highlight .nc { - color: #445588; - font-weight: bold; } - .highlight .no { - color: #008080; } - .highlight .ni { - color: #800080; } - .highlight .ne { - color: #990000; - font-weight: bold; } - .highlight .nf { - color: #990000; } - .highlight .nn { - color: #555555; } - .highlight .nt { - color: #000080; } - .highlight .nv { - color: #008080; } - .highlight .ow { - color: #000000; - font-weight: bold; } - .highlight .w { - color: #bbbbbb; } - .highlight .mf { - color: #009999; } - .highlight .mh { - color: #009999; } - .highlight .mi { - color: #009999; } - .highlight .mo { - color: #009999; } - .highlight .sb { - color: #d14; } - .highlight .sc { - color: #d14; } - .highlight .sd { - color: #d14; } - .highlight .s2 { - color: #d14; } - .highlight .se { - color: #d14; } - .highlight .sh { - color: #d14; } - .highlight .si { - color: #d14; } - .highlight .sx { - color: #d14; } - .highlight .sr { - color: #009926; } - .highlight .s1 { - color: #d14; } - .highlight .ss { - color: #990073; } - .highlight .bp { - color: #999999; } - .highlight .vc { - color: #008080; } - .highlight .vg { - color: #008080; } - .highlight .vi { - color: #008080; } - .highlight .il { - color: #009999; } +.highlight .c { + color: #999988; + font-style: italic; } + +.highlight .err { + color: #a61717; + background-color: #e3d2d2; } + +.highlight .k { + color: #000000; + font-weight: bold; } + +.highlight .o { + color: #000000; + font-weight: bold; } + +.highlight .cm { + color: #999988; + font-style: italic; } + +.highlight .cp { + color: #999999; + font-weight: bold; } + +.highlight .c1 { + color: #999988; + font-style: italic; } + +.highlight .cs { + color: #999999; + font-weight: bold; + font-style: italic; } + +.highlight .gd { + color: #000000; + background-color: #ffdddd; } + +.highlight .gd .x { + color: #000000; + background-color: #ffaaaa; } + +.highlight .ge { + color: #000000; + font-style: italic; } + +.highlight .gr { + color: #aa0000; } + +.highlight .gh { + color: #999999; } + +.highlight .gi { + color: #000000; + background-color: #ddffdd; } + +.highlight .gi .x { + color: #000000; + background-color: #aaffaa; } + +.highlight .go { + color: #888888; } + +.highlight .gp { + color: #555555; } + +.highlight .gs { + font-weight: bold; } + +.highlight .gu { + color: #aaaaaa; } + +.highlight .gt { + color: #aa0000; } + +.highlight .kc { + color: #000000; + font-weight: bold; } + +.highlight .kd { + color: #000000; + font-weight: bold; } + +.highlight .kp { + color: #000000; + font-weight: bold; } + +.highlight .kr { + color: #000000; + font-weight: bold; } + +.highlight .kt { + color: #445588; } + +.highlight .m { + color: #009999; } + +.highlight .s { + color: #d14; } + +.highlight .na { + color: #008080; } + +.highlight .nb { + color: #0086B3; } + +.highlight .nc { + color: #445588; + font-weight: bold; } + +.highlight .no { + color: #008080; } + +.highlight .ni { + color: #800080; } + +.highlight .ne { + color: #990000; + font-weight: bold; } + +.highlight .nf { + color: #990000; } + +.highlight .nn { + color: #555555; } + +.highlight .nt { + color: #000080; } + +.highlight .nv { + color: #008080; } + +.highlight .ow { + color: #000000; + font-weight: bold; } + +.highlight .w { + color: #bbbbbb; } + +.highlight .mf { + color: #009999; } + +.highlight .mh { + color: #009999; } + +.highlight .mi { + color: #009999; } + +.highlight .mo { + color: #009999; } + +.highlight .sb { + color: #d14; } + +.highlight .sc { + color: #d14; } + +.highlight .sd { + color: #d14; } + +.highlight .s2 { + color: #d14; } + +.highlight .se { + color: #d14; } + +.highlight .sh { + color: #d14; } + +.highlight .si { + color: #d14; } + +.highlight .sx { + color: #d14; } + +.highlight .sr { + color: #009926; } + +.highlight .s1 { + color: #d14; } + +.highlight .ss { + color: #990073; } + +.highlight .bp { + color: #999999; } + +.highlight .vc { + color: #008080; } + +.highlight .vg { + color: #008080; } + +.highlight .vi { + color: #008080; } + +.highlight .il { + color: #009999; } diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/css/jazzy.css b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/css/jazzy.css index c3090c0..2e38713 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/css/jazzy.css +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/css/jazzy.css @@ -1,3 +1,7 @@ +/*! Jazzy - https://github.com/realm/jazzy + * Copyright Realm Inc. + * SPDX-License-Identifier: MIT + */ html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td { background: transparent; border: 0; @@ -56,9 +60,14 @@ p code, li code { padding: 2px 4px; border-radius: 4px; } +pre > code { + padding: 0; } + a { color: #0088cc; text-decoration: none; } + a code { + color: inherit; } ul { padding-left: 15px; } @@ -74,20 +83,32 @@ blockquote { padding: 0 10px; border-left: 4px solid #ccc; } +hr { + height: 1px; + border: none; + background-color: #e2e2e2; } + +.footnote-ref { + display: inline-block; + scroll-margin-top: 70px; } + +.footnote-def { + scroll-margin-top: 70px; } + .content-wrapper { margin: 0 auto; width: 980px; } header { font-size: 0.85em; - line-height: 26px; + line-height: 32px; background-color: #414141; position: fixed; width: 100%; - z-index: 2; } + z-index: 3; } header img { padding-right: 6px; - vertical-align: -4px; + vertical-align: -3px; height: 16px; } header a { color: #fff; } @@ -100,12 +121,12 @@ header { #breadcrumbs { background-color: #f2f2f2; - height: 27px; + height: 21px; padding-top: 17px; position: fixed; width: 100%; z-index: 2; - margin-top: 26px; } + margin-top: 32px; } #breadcrumbs #carat { height: 10px; margin: 0 5px; } @@ -199,6 +220,7 @@ header { margin-left: 18px; } .task-group-section { + margin-top: 10px; padding-left: 6px; border-top: 1px solid #e2e2e2; } @@ -372,3 +394,46 @@ html.dash .content-wrapper { html.dash #footer { position: static; } + +form[role=search] { + float: right; } + form[role=search] input { + font: Helvetica, freesans, Arial, sans-serif; + margin-top: 6px; + font-size: 13px; + line-height: 20px; + padding: 0px 10px; + border: none; + border-radius: 1em; } + .loading form[role=search] input { + background: white url(../img/spinner.gif) center right 4px no-repeat; } + form[role=search] .tt-menu { + margin: 0; + min-width: 300px; + background: #fff; + color: #333; + border: 1px solid #e2e2e2; + z-index: 4; } + form[role=search] .tt-highlight { + font-weight: bold; } + form[role=search] .tt-suggestion { + font: Helvetica, freesans, Arial, sans-serif; + font-size: 14px; + padding: 0 8px; } + form[role=search] .tt-suggestion span { + display: table-cell; + white-space: nowrap; } + form[role=search] .tt-suggestion .doc-parent-name { + width: 100%; + text-align: right; + font-weight: normal; + font-size: 0.9em; + padding-left: 16px; } + form[role=search] .tt-suggestion:hover, + form[role=search] .tt-suggestion.tt-cursor { + cursor: pointer; + background-color: #4183c4; + color: #fff; } + form[role=search] .tt-suggestion:hover .doc-parent-name, + form[role=search] .tt-suggestion.tt-cursor .doc-parent-name { + color: #fff; } diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/img/spinner.gif b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/img/spinner.gif new file mode 100644 index 0000000..e3038d0 Binary files /dev/null and b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/img/spinner.gif differ diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/index.html b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/index.html index 0cca5e6..49fefd5 100644 --- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/index.html +++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/index.html @@ -8,19 +8,27 @@ + + +
                                                                                                                                                                                    -

                                                                                                                                                                                    OSSSpeechKit 0.3.0 Docs (95% documented)

                                                                                                                                                                                    -

                                                                                                                                                                                    View on GitHub

                                                                                                                                                                                    +

                                                                                                                                                                                    OSSSpeechKit 1.0.0 Docs (100% documented)

                                                                                                                                                                                    +

                                                                                                                                                                                    GitHubView on GitHub

                                                                                                                                                                                    +
                                                                                                                                                                                    +
                                                                                                                                                                                    + +
                                                                                                                                                                                    +
                                                                                                                                                                                    @@ -33,6 +41,12 @@
                                                                                                                                                                                  • OSSSpeech
                                                                                                                                                                                    • +
                                                                                                                                                                                  • + OSSSpeechEngine +
                                                                                                                                                                                    • +
                                                                                                                                                                                  • + – State +
                                                                                                                                                                                  • OSSSpeechUtility
                                                                                                                                                                                    • @@ -47,12 +61,18 @@
                                                                                                                                                                                  • Enumerations
                                                                                                                                                                                      +
                                                                                                                                                                                    • + OSSSpeechError +
                                                                                                                                                                                    • OSSSpeechKitAuthorizationStatus
                                                                                                                                                                                    • OSSSpeechKitErrorType
                                                                                                                                                                                      • +
                                                                                                                                                                                    • + OSSSpeechRecognitionEvent +
                                                                                                                                                                                    • OSSSpeechRecognitionTaskType
                                                                                                                                                                                      • @@ -64,9 +84,6 @@
                                                                                                                                                                                    • Extensions
                                                                                                                                                                                        -
                                                                                                                                                                                      • - Bundle -
                                                                                                                                                                                      • NSObject
                                                                                                                                                                                        • @@ -83,6 +100,15 @@
                                                                                                                                                                                      • Structures
                                                                                                                                                                                          +
                                                                                                                                                                                        • + OSSLanguage +
                                                                                                                                                                                          • +
                                                                                                                                                                                        • + OSSUtteranceConfiguration +
                                                                                                                                                                                          • +
                                                                                                                                                                                        • + OSSVoiceConfiguration +
                                                                                                                                                                                        • OSSVoiceInfo
                                                                                                                                                                                          • @@ -96,235 +122,159 @@

                                                                                                                                                                                          OSSSpeechKit

                                                                                                                                                                                          -

                                                                                                                                                                                          OSSSpeechKit Logo

                                                                                                                                                                                          - -

                                                                                                                                                                                          CI Status -Version -License -Platform -codecov -docs

                                                                                                                                                                                          - -

                                                                                                                                                                                          OSSSpeechKit was developed to provide easier accessibility options to apps.

                                                                                                                                                                                          - -

                                                                                                                                                                                          Apple does not make it easy to get the right voice, nor do they provide a simple way of selecting a language or using speech to text. OSSSpeechKit makes the hassle of trying to find the right language go away.

                                                                                                                                                                                          -

                                                                                                                                                                                          Requirements

                                                                                                                                                                                          +

                                                                                                                                                                                          OSSSpeechKit is an iOS library for speech synthesis and speech recognition built on Apple’s AVFoundation and Speech frameworks.

                                                                                                                                                                                          +

                                                                                                                                                                                          Requirements

                                                                                                                                                                                            -
                                                                                                                                                                                          • Swift 5.0 or higher
                                                                                                                                                                                            • -
                                                                                                                                                                                          • iOS 12.0 or higher
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Cocoapods
                                                                                                                                                                                            • -
                                                                                                                                                                                          • A real device
                                                                                                                                                                                            • +
                                                                                                                                                                                          • iOS 17 or later
                                                                                                                                                                                            • +
                                                                                                                                                                                          • Swift 5 language mode or later
                                                                                                                                                                                            • +
                                                                                                                                                                                          • Xcode with Swift 6 package support
                                                                                                                                                                                          -

                                                                                                                                                                                          Supported Languages

                                                                                                                                                                                          - -
                                                                                                                                                                                          English - Australian
                                                                                                                                                                                          🇦🇺                                                                                                                                                                                           		Hebrew
                                                                                                                                                                                          🇮🇱                                                                                                                                                                                           		Japanese
                                                                                                                                                                                          🇯🇵                                                                                                                                                                                           		Romanian
                                                                                                                                                                                          🇷🇴                                                                                                                                                                                           		Swedish
                                                                                                                                                                                          🇸🇪                                                                                                                                                                                           		Norsk
                                                                                                                                                                                          🇳🇴
                                                                                                                                                                                          Portuguese - Brazilian
                                                                                                                                                                                          🇧🇷                                                                                                                                                                                           		Hindi - Indian
                                                                                                                                                                                          🇮🇳                                                                                                                                                                                           		Korean
                                                                                                                                                                                          🇰🇷                                                                                                                                                                                           		Russian
                                                                                                                                                                                          🇷🇺                                                                                                                                                                                           		Chinese - Taiwanese
                                                                                                                                                                                          🇹🇼                                                                                                                                                                                           		Dutch - Belgium
                                                                                                                                                                                          🇧🇪
                                                                                                                                                                                          French - Canadian
                                                                                                                                                                                          🇨🇦                                                                                                                                                                                           		Hungarian
                                                                                                                                                                                          🇭🇺                                                                                                                                                                                           		Spanish - Mexican
                                                                                                                                                                                          🇲🇽                                                                                                                                                                                           		Arabic - Saudi Arabian
                                                                                                                                                                                          🇸🇦                                                                                                                                                                                           		Thai
                                                                                                                                                                                          🇹🇭                                                                                                                                                                                           		French
                                                                                                                                                                                          🇫🇷
                                                                                                                                                                                          Chinese
                                                                                                                                                                                          🇨🇳                                                                                                                                                                                           		Indonesian
                                                                                                                                                                                          🇮🇩                                                                                                                                                                                           		Norwegian
                                                                                                                                                                                          🇳🇴                                                                                                                                                                                           		Slovakian
                                                                                                                                                                                          🇸🇰                                                                                                                                                                                           		Turkish
                                                                                                                                                                                          🇹🇷                                                                                                                                                                                           		Finnish
                                                                                                                                                                                          🇫🇮
                                                                                                                                                                                          Chinese - Hong Kong
                                                                                                                                                                                          🇭🇰                                                                                                                                                                                           		English - Irish
                                                                                                                                                                                          🇮🇪                                                                                                                                                                                           		Polish
                                                                                                                                                                                          🇵🇱                                                                                                                                                                                           		English - South African
                                                                                                                                                                                          🇿🇦                                                                                                                                                                                           		English - United States
                                                                                                                                                                                          🇺🇸                                                                                                                                                                                           		Danish
                                                                                                                                                                                          🇩🇰
                                                                                                                                                                                          Czech
                                                                                                                                                                                          🇨🇿                                                                                                                                                                                           		Italian
                                                                                                                                                                                          🇮🇹                                                                                                                                                                                           		Portuguese
                                                                                                                                                                                          🇵🇹                                                                                                                                                                                           		Spanish
                                                                                                                                                                                          🇪🇸                                                                                                                                                                                           		English
                                                                                                                                                                                          🇬🇧                                                                                                                                                                                          		 Dutch
                                                                                                                                                                                          🇳🇱
                                                                                                                                                                                          Greek
                                                                                                                                                                                          🇬🇷
                                                                                                                                                                                          -

                                                                                                                                                                                          Features

                                                                                                                                                                                          - -

                                                                                                                                                                                          OSSSpeechKit offers simple text to speech and speech to text in 37 different languages.

                                                                                                                                                                                          +

                                                                                                                                                                                          Installation

                                                                                                                                                                                          -

                                                                                                                                                                                          OSSSpeechKit is built on top of both the AVFoundation and Speech frameworks.

                                                                                                                                                                                          - -

                                                                                                                                                                                          You can achieve text to speech or speech to text in as little as two lines of code.

                                                                                                                                                                                          +

                                                                                                                                                                                          In Xcode, choose File > Add Package Dependencies, enter:

                                                                                                                                                                                          +
                                                                                                                                                                                          https://github.com/AppDevGuy/OSSSpeechKit.git
+
                                                                                                                                                                                          -

                                                                                                                                                                                          The speech will play over the top of other sounds such as music.

                                                                                                                                                                                          -

                                                                                                                                                                                          Installation

                                                                                                                                                                                          +

                                                                                                                                                                                          Select version 1.0.0 or later and add the OSSSpeechKit library product to your app target.

                                                                                                                                                                                          -

                                                                                                                                                                                          OSSSpeechKit is available through CocoaPods. To install -it, simply add the following line to your Podfile:

                                                                                                                                                                                          -
                                                                                                                                                                                          pod 'OSSSpeechKit'
+
                                                                                                                                                                                          You can also add it to Package.swift:
                                                                                                                                                                                          
+
                                                                                                                                                                                          dependencies: [
+    .package(
+        url: "https://github.com/AppDevGuy/OSSSpeechKit.git",
+        from: "1.0.0"
+    )
+]
 
                                                                                                                                                                                          
-
                                                                                                                                                                                          Implementation
                                                                                                                                                                                          
-
                                                                                                                                                                                          Text to Speech
                                                                                                                                                                                          
 
-
                                                                                                                                                                                          These methods enable you to pass in a string and hear the text played back using.
                                                                                                                                                                                          
-
                                                                                                                                                                                          Simple
                                                                                                                                                                                          
-
                                                                                                                                                                                          import OSSSpeechKit
+
                                                                                                                                                                                          Swift Package Manager is the only supported installation method. The historical CocoaPods release 0.3.3 remains available for existing builds but is no longer maintained; version 1.0 and later are not published to CocoaPods.
                                                                                                                                                                                          
+
                                                                                                                                                                                          Speech synthesis
                                                                                                                                                                                          
 
-.....
+
                                                                                                                                                                                          OSSSpeechEngine is main-actor isolated and instance based. Select a language from the catalog, confirm that a voice exists on the current device, then speak:
                                                                                                                                                                                          
+
                                                                                                                                                                                          import AVFoundation
+import OSSSpeechKit
 
-// Declare an instance of OSSSpeechKit
-let speechKit = OSSSpeech.shared
-// Set the voice you wish to use - currently upper case for formality or language and country name
-speechKit.voice = OSSVoice(quality: .enhanced, language: .Australian)
-// Set the text in the language you have set
-speechKit.speakText(text: "Hello, my name is OSSSpeechKit.")
-
                                                                                                                                                                                          
-
                                                                                                                                                                                          Advanced
                                                                                                                                                                                          
-
                                                                                                                                                                                          import OSSSpeechKit
+let engine = OSSSpeechEngine()
+let language = OSSLanguage.catalog.first {
+    $0.id == "english-australia"
+}!
 
-.....
+guard !language.availableSynthesisVoices.isEmpty else {
+    // Ask the user to install a compatible system voice.
+    return
+}
 
-// Declare an instance of OSSSpeechKit
-let speechKit = OSSSpeech.shared
-// Create a voice instance
-let newVoice = OSSVoice()
-// Set the language
-newVoice.language = OSSVoiceEnum.Australian.rawValue
-// Set the voice quality
-newVoice.quality = .enhanced
-// Set the voice of the speech kit
-speechKit.voice = newVoice
-// Initialise an utterance
-let utterance = OSSUtterance(string: "Testing")
-// Set the recognition task type 
-speechKit.recognitionTaskType = .dictation
-// Set volume
-utterance.volume = 0.5
-// Set rate of speech
-utterance.rate = 0.5
-// Set the pitch 
-utterance.pitchMultiplier = 1.2
-// Set speech utterance
-speechKit.utterance = utterance
-// Ask to speak
-speechKit.speakText(text: utterance.speechString)
+try await engine.speak(
+    "Hello from OSSSpeechKit.",
+    voice: OSSVoiceConfiguration(
+        language: language,
+        preferredQuality: .enhanced
+    ),
+    configuration: OSSUtteranceConfiguration(
+        rate: AVSpeechUtteranceDefaultSpeechRate,
+        pitchMultiplier: 1,
+        volume: 1
+    )
+)
 
                                                                                                                                                                                          
-
                                                                                                                                                                                          Speech to Text
                                                                                                                                                                                          
 
-
                                                                                                                                                                                          Currently speech to text is offered in a very simple format. Starting and stopping of recording is handled by the app. 
                                                                                                                                                                                          
-
                                                                                                                                                                                          iOS 13 On-Device Speech to Text support is now available as of 0.3.0 🎉
                                                                                                                                                                                          
+
                                                                                                                                                                                          Use pauseSpeaking(), continueSpeaking(), and stopSpeaking() to control playback.
                                                                                                                                                                                          
+
                                                                                                                                                                                          Speech recognition
                                                                                                                                                                                          
 
-
                                                                                                                                                                                          SpeechKit implements delegates to handle the recording authorization, output of text and failure to record.
                                                                                                                                                                                          
-
                                                                                                                                                                                          speechKit.delegate = self
-// Call to start and end recording. 
-speechKit.recordVoice()
-// Call to end recording
-speechKit.endVoiceRecording()
+
                                                                                                                                                                                          Add both usage descriptions to the consuming app’s Info.plist:
                                                                                                                                                                                          
+
                                                                                                                                                                                          <key>NSMicrophoneUsageDescription</key>
+<string>Explain why your app records audio.</string>
+<key>NSSpeechRecognitionUsageDescription</key>
+<string>Explain why your app transcribes speech.</string>
 
                                                                                                                                                                                          
 
-
                                                                                                                                                                                          It is important that you have included in your info.plist the following:
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          
-
                                                                                                                                                                                          Privacy - Speech Recognition Usage Description
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          Privacy - Microphone Usage Description
                                                                                                                                                                                          
-
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          Without these, you will not be able to access the microphone nor speech recognition.
                                                                                                                                                                                          
-
                                                                                                                                                                                          Delegates
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          Handle returning authentication status to user - primary use is for non-authorized state.
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          
-
                                                                                                                                                                                          func authorizationToMicrophone(withAuthentication type: OSSSpeechKitAuthorizationStatus)
                                                                                                                                                                                          
-
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          When the microphone has finished accepting audio, this delegate will be called with the final best text output.
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          
-
                                                                                                                                                                                          func didFailToCommenceSpeechRecording()
                                                                                                                                                                                          
-
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          If the speech recogniser and request fail to set up, this method will be called.
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          
-
                                                                                                                                                                                          func didFinishListening(withText text: String)
                                                                                                                                                                                          
-
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          For further information you can check out the Apple documentation directly.
                                                                                                                                                                                          
-
                                                                                                                                                                                          Other Features
                                                                                                                                                                                          
-
                                                                                                                                                                                          List all available voices:
                                                                                                                                                                                          
-
                                                                                                                                                                                          let allLanguages = OSSVoiceEnum.allCases
-
                                                                                                                                                                                          
-
                                                                                                                                                                                          Get specific voice information:
                                                                                                                                                                                          
-
                                                                                                                                                                                          // All support languages
-let allVoices = OSSVoiceEnum.allCases
-// Language details
-let languageInformation = allVoices[0].getDetails()
-// Flag of country
-let flag = allVoices[0].flag
+
                                                                                                                                                                                          Then consume recognition events:
                                                                                                                                                                                          
+
                                                                                                                                                                                          let engine = OSSSpeechEngine()
+
+do {
+    let events = try await engine.recognitionEvents(
+        locale: Locale(identifier: "en-AU")
+    )
+
+    for try await event in events {
+        switch event {
+        case .partial(let text):
+            print("Partial:", text)
+        case .completed(let text):
+            print("Final:", text)
+        case .availabilityChanged(let available):
+            print("Available:", available)
+        case .cancelled:
+            break
+        }
+    }
+} catch {
+    print("Recognition failed:", error)
+}
 
                                                                                                                                                                                          
 
-
                                                                                                                                                                                          The getDetails() method returns a struct containing:
                                                                                                                                                                                          
-
                                                                                                                                                                                          OSSVoiceInfo {
-    /// The name of the voice; All AVSpeechSynthesisVoice instances have a persons name.
-    var name: String?
-    /// The name of the language being used.
-    var language: String?
-    /// The language code is what is internationally used in Locale settings.
-    var languageCode: String?
-    /// Identifier is a unique bundle url provided by Apple for each AVSpeechSynthesisVoice.
-    var identifier: Any?
+
                                                                                                                                                                                          Call cancelRecognition() to stop an active session. Set usesOnDeviceRecognition = true before starting if your product requires on-device recognition; the operation fails when the selected recognizer does not support it.
                                                                                                                                                                                          
+
                                                                                                                                                                                          Languages, voices, and flags
                                                                                                                                                                                          
+
+
                                                                                                                                                                                          OSSLanguage.catalog is display metadata, not a guarantee of runtime support. Availability varies by OS release, device, installed voice assets, region, network access, and Apple’s services.
                                                                                                                                                                                          
+
+
                                                                                                                                                                                          The catalog was reconciled against Apple’s current
+VoiceOver language support and
+feature availability pages.
+Exact synthesis voices come from
+AVSpeechSynthesisVoice.speechVoices()
+and recognition locales come from
+SFSpeechRecognizer.supportedLocales();
+those runtime results are authoritative.
                                                                                                                                                                                          
+
+
                                                                                                                                                                                          Check capabilities when presenting an option:
                                                                                                                                                                                          
+
                                                                                                                                                                                          for language in OSSLanguage.catalog {
+    let canSpeak = !language.availableSynthesisVoices.isEmpty
+    let canRecognize = language.supportsRecognition
+    let flag = language.flagEmoji
+    print(flag, language.name, canSpeak, canRecognize)
 }
 
                                                                                                                                                                                          
-
                                                                                                                                                                                          Other Info
                                                                                                                                                                                          
 
-
                                                                                                                                                                                          The OSSVoiceEnum contains other methods, such as a hello message, title variable and subtitle variable so you can use it in a list. 
                                                                                                                                                                                          
+
                                                                                                                                                                                          For UIKit code that needs an image, use:
                                                                                                                                                                                          
+
                                                                                                                                                                                          let image = language.renderedFlagImage(pointSize: 24)
+
                                                                                                                                                                                          
 
-
                                                                                                                                                                                          You can also set the speech:
                                                                                                                                                                                          
+
                                                                                                                                                                                          Speech synthesis is not translation. Supply text written for the selected language and locale.
                                                                                                                                                                                          
+
                                                                                                                                                                                          Privacy
                                                                                                                                                                                          
 
-
                                                                                                                                                                                            
-
                                                                                                                                                                                          • volume
                                                                                                                                                                                            • 
-
                                                                                                                                                                                          • pitchMultiplier
                                                                                                                                                                                            • 
-
                                                                                                                                                                                          • rate
                                                                                                                                                                                            • 
-
                                                                                                                                                                                          
+
                                                                                                                                                                                          OSSSpeechKit requests microphone and speech-recognition permission only when your app asks it to. Your app is responsible for clear NSMicrophoneUsageDescription and NSSpeechRecognitionUsageDescription strings and for disclosing its own data practices.
                                                                                                                                                                                          
 
-
                                                                                                                                                                                          As well as using an NSAttributedString.
                                                                                                                                                                                          
+
                                                                                                                                                                                          Speech recognition may use Apple services unless on-device recognition is requested and supported. Review Apple’s current Speech framework and App Store privacy requirements for your use case.
                                                                                                                                                                                          
 
-
                                                                                                                                                                                          There are plans to implement flags for each country as well as some more features, such as being able to play the voice if the device is on silent. 
                                                                                                                                                                                          
+
                                                                                                                                                                                          The included PrivacyInfo.xcprivacy declares that OSSSpeechKit itself does not track users, collect data, or access a required-reason API. It does not replace the consuming app’s privacy manifest or App Privacy answers.
                                                                                                                                                                                          
+
                                                                                                                                                                                          Migrating from pre-1.0
                                                                                                                                                                                          
 
-
                                                                                                                                                                                          If the language or voice you require is not available, this is either due to:
                                                                                                                                                                                          
+
                                                                                                                                                                                          The singleton and subclass-based APIs remain temporarily available but are deprecated:
                                                                                                                                                                                          
 
 
-
                                                                                                                                                                                          Important Information
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          Apple do not make the voice of Siri available for use. 
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          This kit provides Apple’s AVFoundation voices available and easy to use, so you do not need to know all the voice codes, among many other things.
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          To say things correctly in each language, you need to set the voice to the correct language and supply that languages text; this SDK is not a translator. 
                                                                                                                                                                                          
-
                                                                                                                                                                                          Code Example:
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          You wish for you app to use a Chinese voice, you will need to ensure the text being passed in is Chinese. 
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          Disclaimer: I do not know how to speak Chinese, I have used Google translate for the Chinese characters.
                                                                                                                                                                                          
-
                                                                                                                                                                                          Correct:
                                                                                                                                                                                          
-
                                                                                                                                                                                          speechKit.voice = OSSVoice(quality: .enhanced, language: .Chinese)
-speechKit.speakText(text: "你好我的名字是 ...")
-
                                                                                                                                                                                          
-
                                                                                                                                                                                          Incorrect:
                                                                                                                                                                                          
-
                                                                                                                                                                                          speechKit.voice = OSSVoice(quality: .enhanced, language: .Australian)
-speechKit.speakText(text: "你好我的名字是 ...")
-
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          OR
                                                                                                                                                                                          
-
                                                                                                                                                                                          speechKit.voice = OSSVoice(quality: .enhanced, language: .Chinese)
-speechKit.speakText(text: "Hello, my name is ...")
-
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          This same principle applies to all other languages such as German, Saudi Arabian, French, etc.. Failing to set the language for the text you wish to be spoken will not sound correct. 
                                                                                                                                                                                          
-
                                                                                                                                                                                          Contributions and Queries
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          If you have a question, please create a ticket or email me directly. 
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          If you wish to contribute, please create a pull request. 
                                                                                                                                                                                          
-
                                                                                                                                                                                          Example Project
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          To run the example project, clone the repo, and run pod install from the Example directory first.
                                                                                                                                                                                          
-
                                                                                                                                                                                          Unit Tests
                                                                                                                                                                                          
-
-
                                                                                                                                                                                          For further examples, please look at the Unit Test class.
                                                                                                                                                                                          
-
                                                                                                                                                                                          Author
                                                                                                                                                                                          
 
-
                                                                                                                                                                                          App Dev Guy
                                                                                                                                                                                          
+
                                                                                                                                                                                          See MIGRATION.md for examples and behavior changes.
                                                                                                                                                                                          
+
                                                                                                                                                                                          Example and tests
                                                                                                                                                                                          
 
-
                                                                                                                                                                                          profile for App Dev Guy at Stack Overflow, Q&A for professional and enthusiast programmers
                                                                                                                                                                                          
-
                                                                                                                                                                                          License
                                                                                                                                                                                          
+
                                                                                                                                                                                          Open Example/OSSSpeechKit.xcodeproj to run the example app and its tests. The project links the package from the repository root.
                                                                                                                                                                                          
+
                                                                                                                                                                                          License
                                                                                                                                                                                          
 
-
                                                                                                                                                                                          OSSSpeechKit is available under the MIT license. See the LICENSE file for more info.
                                                                                                                                                                                          
+
                                                                                                                                                                                          OSSSpeechKit is available under the MIT license. See LICENSE.
                                                                                                                                                                                          
 
           
         
         
       
     
   
-
 
diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/jazzy.js b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/jazzy.js
index 1e55d6e..1984416 100755
--- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/jazzy.js
+++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/jazzy.js
@@ -1,3 +1,7 @@
+// Jazzy - https://github.com/realm/jazzy
+// Copyright Realm Inc.
+// SPDX-License-Identifier: MIT
+
 window.jazzy = {'docset': false}
 if (typeof window.dash != 'undefined') {
   document.documentElement.className += ' dash'
diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/jazzy.search.js b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/jazzy.search.js
new file mode 100644
index 0000000..359cdbb
--- /dev/null
+++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/jazzy.search.js
@@ -0,0 +1,74 @@
+// Jazzy - https://github.com/realm/jazzy
+// Copyright Realm Inc.
+// SPDX-License-Identifier: MIT
+
+$(function(){
+  var $typeahead = $('[data-typeahead]');
+  var $form = $typeahead.parents('form');
+  var searchURL = $form.attr('action');
+
+  function displayTemplate(result) {
+    return result.name;
+  }
+
+  function suggestionTemplate(result) {
+    var t = '
                                                                                                                                                                                          ';
+    t += '' + result.name + '';
+    if (result.parent_name) {
+     t += '' + result.parent_name + '';
+    }
+    t += '
                                                                                                                                                                                          ';
+    return t;
+  }
+
+  $typeahead.one('focus', function() {
+    $form.addClass('loading');
+
+    $.getJSON(searchURL).then(function(searchData) {
+      const searchIndex = lunr(function() {
+        this.ref('url');
+        this.field('name');
+        this.field('abstract');
+        for (const [url, doc] of Object.entries(searchData)) {
+          this.add({url: url, name: doc.name, abstract: doc.abstract});
+        }
+      });
+
+      $typeahead.typeahead(
+        {
+          highlight: true,
+          minLength: 3,
+          autoselect: true
+        },
+        {
+          limit: 10,
+          display: displayTemplate,
+          templates: { suggestion: suggestionTemplate },
+          source: function(query, sync) {
+            const lcSearch = query.toLowerCase();
+            const results = searchIndex.query(function(q) {
+                q.term(lcSearch, { boost: 100 });
+                q.term(lcSearch, {
+                  boost: 10,
+                  wildcard: lunr.Query.wildcard.TRAILING
+                });
+            }).map(function(result) {
+              var doc = searchData[result.ref];
+              doc.url = result.ref;
+              return doc;
+            });
+            sync(results);
+          }
+        }
+      );
+      $form.removeClass('loading');
+      $typeahead.trigger('focus');
+    });
+  });
+
+  var baseURL = searchURL.slice(0, -"search.json".length);
+
+  $typeahead.on('typeahead:select', function(e, result) {
+    window.location = baseURL + result.url;
+  });
+});
diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/jquery.min.js b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/jquery.min.js
index a1c07fd..2c69bc9 100644
--- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/jquery.min.js
+++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/jquery.min.js
@@ -1,2 +1,2 @@
-/*! jQuery v3.4.1 | (c) JS Foundation and other contributors | jquery.org/license */
-!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],E=C.document,r=Object.getPrototypeOf,s=t.slice,g=t.concat,u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.4.1",k=function(e,t){return new k.fn.init(e,t)},p=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;function d(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp($),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+$),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),ne=function(e,t,n){var r="0x"+t-65536;return r!=r||n?t:r<0?String.fromCharCode(r+65536):String.fromCharCode(r>>10|55296,1023&r|56320)},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(m.childNodes),m.childNodes),t[m.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&((e?e.ownerDocument||e:m)!==C&&T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!A[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&U.test(t)){(s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=k),o=(l=h(t)).length;while(o--)l[o]="#"+s+" "+xe(l[o]);c=l.join(","),f=ee.test(t)&&ye(e.parentNode)||e}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){A(t,!0)}finally{s===k&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[k]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:m;return r!==C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),m!==C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=k,!C.getElementsByName||!C.getElementsByName(k).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+k+"-]").length||v.push("~="),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+k+"+*").length||v.push(".#.+[+~]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",$)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)===(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e===C||e.ownerDocument===m&&y(m,e)?-1:t===C||t.ownerDocument===m&&y(m,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e===C?-1:t===C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]===m?-1:s[r]===m?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if((e.ownerDocument||e)!==C&&T(e),d.matchesSelector&&E&&!A[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){A(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=p[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&p(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?k.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?k.grep(e,function(e){return e===n!==r}):"string"!=typeof n?k.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(k.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||q,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:L.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof k?t[0]:t,k.merge(this,k.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),D.test(r[1])&&k.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(k):k.makeArray(e,this)}).prototype=k.fn,q=k(E);var H=/^(?:parents|prev(?:Until|All))/,O={children:!0,contents:!0,next:!0,prev:!0};function P(e,t){while((e=e[t])&&1!==e.nodeType);return e}k.fn.extend({has:function(e){var t=k(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i,ge={option:[1,""],thead:[1,"","
                                                                                                                                                                                          "],col:[2,"","
                                                                                                                                                                                          "],tr:[2,"","
                                                                                                                                                                                          "],td:[3,"","
                                                                                                                                                                                          "],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?k.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;nx",y.noCloneChecked=!!me.cloneNode(!0).lastChild.defaultValue;var Te=/^key/,Ce=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Ee=/^([^.]*)(?:\.(.+)|)/;function ke(){return!0}function Se(){return!1}function Ne(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function Ae(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)Ae(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Se;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return k().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=k.guid++)),e.each(function(){k.event.add(this,t,i,r,n)})}function De(e,i,o){o?(Q.set(e,i,!1),k.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Q.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(k.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Q.set(this,i,r),t=o(this,i),this[i](),r!==(n=Q.get(this,i))||t?Q.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Q.set(this,i,{value:k.event.trigger(k.extend(r[0],k.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Q.get(e,i)&&k.event.add(e,i,ke)}k.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.get(t);if(v){n.handler&&(n=(o=n).handler,i=o.selector),i&&k.find.matchesSelector(ie,i),n.guid||(n.guid=k.guid++),(u=v.events)||(u=v.events={}),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof k&&k.event.triggered!==e.type?k.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(R)||[""]).length;while(l--)d=g=(s=Ee.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=k.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=k.event.special[d]||{},c=k.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&k.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),k.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.hasData(e)&&Q.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(R)||[""]).length;while(l--)if(d=g=(s=Ee.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=k.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||k.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)k.event.remove(e,d+t[l],n,r,!0);k.isEmptyObject(u)&&Q.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=k.event.fix(e),u=new Array(arguments.length),l=(Q.get(this,"events")||{})[s.type]||[],c=k.event.special[s.type]||{};for(u[0]=s,t=1;t\x20\t\r\n\f]*)[^>]*)\/>/gi,qe=/\s*$/g;function Oe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&k(e).children("tbody")[0]||e}function Pe(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function Re(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Me(e,t){var n,r,i,o,a,s,u,l;if(1===t.nodeType){if(Q.hasData(e)&&(o=Q.access(e),a=Q.set(t,o),l=o.events))for(i in delete a.handle,a.events={},l)for(n=0,r=l[i].length;n")},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=oe(e);if(!(y.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||k.isXMLDoc(e)))for(a=ve(c),r=0,i=(o=ve(e)).length;r").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Vt,Gt=[],Yt=/(=)\?(?=&|$)|\?\?/;k.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Gt.pop()||k.expando+"_"+kt++;return this[e]=!0,e}}),k.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Yt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Yt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Yt,"$1"+r):!1!==e.jsonp&&(e.url+=(St.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||k.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?k(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Gt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Vt=E.implementation.createHTMLDocument("").body).innerHTML="
                                                                                                                                                                                          ",2===Vt.childNodes.length),k.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=D.exec(e))?[t.createElement(i[1])]:(i=we([e],t,o),o&&o.length&&k(o).remove(),k.merge([],i.childNodes)));var r,i,o},k.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(k.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},k.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){k.fn[t]=function(e){return this.on(t,e)}}),k.expr.pseudos.animated=function(t){return k.grep(k.timers,function(e){return t===e.elem}).length},k.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=k.css(e,"position"),c=k(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=k.css(e,"top"),u=k.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,k.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},k.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){k.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===k.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===k.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=k(e).offset()).top+=k.css(e,"borderTopWidth",!0),i.left+=k.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-k.css(r,"marginTop",!0),left:t.left-i.left-k.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===k.css(e,"position"))e=e.offsetParent;return e||ie})}}),k.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;k.fn[t]=function(e){return _(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),k.each(["top","left"],function(e,n){k.cssHooks[n]=ze(y.pixelPosition,function(e,t){if(t)return t=_e(e,n),$e.test(t)?k(e).position()[n]+"px":t})}),k.each({Height:"height",Width:"width"},function(a,s){k.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){k.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return _(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?k.css(e,t,i):k.style(e,t,n,i)},s,n?e:void 0,n)}})}),k.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){k.fn[n]=function(e,t){return 0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
                                                                                                                                                                                          "],col:[2,"","
                                                                                                                                                                                          "],tr:[2,"","
                                                                                                                                                                                          "],td:[3,"","
                                                                                                                                                                                          "],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
                                                                                                                                                                                          ",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}();
diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/typeahead.jquery.js b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/typeahead.jquery.js
new file mode 100644
index 0000000..3a2d2ab
--- /dev/null
+++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/js/typeahead.jquery.js
@@ -0,0 +1,1694 @@
+/*!
+ * typeahead.js 1.3.1
+ * https://github.com/corejavascript/typeahead.js
+ * Copyright 2013-2020 Twitter, Inc. and other contributors; Licensed MIT
+ */
+
+
+(function(root, factory) {
+    if (typeof define === "function" && define.amd) {
+        define([ "jquery" ], function(a0) {
+            return factory(a0);
+        });
+    } else if (typeof module === "object" && module.exports) {
+        module.exports = factory(require("jquery"));
+    } else {
+        factory(root["jQuery"]);
+    }
+})(this, function($) {
+    var _ = function() {
+        "use strict";
+        return {
+            isMsie: function() {
+                return /(msie|trident)/i.test(navigator.userAgent) ? navigator.userAgent.match(/(msie |rv:)(\d+(.\d+)?)/i)[2] : false;
+            },
+            isBlankString: function(str) {
+                return !str || /^\s*$/.test(str);
+            },
+            escapeRegExChars: function(str) {
+                return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&");
+            },
+            isString: function(obj) {
+                return typeof obj === "string";
+            },
+            isNumber: function(obj) {
+                return typeof obj === "number";
+            },
+            isArray: $.isArray,
+            isFunction: $.isFunction,
+            isObject: $.isPlainObject,
+            isUndefined: function(obj) {
+                return typeof obj === "undefined";
+            },
+            isElement: function(obj) {
+                return !!(obj && obj.nodeType === 1);
+            },
+            isJQuery: function(obj) {
+                return obj instanceof $;
+            },
+            toStr: function toStr(s) {
+                return _.isUndefined(s) || s === null ? "" : s + "";
+            },
+            bind: $.proxy,
+            each: function(collection, cb) {
+                $.each(collection, reverseArgs);
+                function reverseArgs(index, value) {
+                    return cb(value, index);
+                }
+            },
+            map: $.map,
+            filter: $.grep,
+            every: function(obj, test) {
+                var result = true;
+                if (!obj) {
+                    return result;
+                }
+                $.each(obj, function(key, val) {
+                    if (!(result = test.call(null, val, key, obj))) {
+                        return false;
+                    }
+                });
+                return !!result;
+            },
+            some: function(obj, test) {
+                var result = false;
+                if (!obj) {
+                    return result;
+                }
+                $.each(obj, function(key, val) {
+                    if (result = test.call(null, val, key, obj)) {
+                        return false;
+                    }
+                });
+                return !!result;
+            },
+            mixin: $.extend,
+            identity: function(x) {
+                return x;
+            },
+            clone: function(obj) {
+                return $.extend(true, {}, obj);
+            },
+            getIdGenerator: function() {
+                var counter = 0;
+                return function() {
+                    return counter++;
+                };
+            },
+            templatify: function templatify(obj) {
+                return $.isFunction(obj) ? obj : template;
+                function template() {
+                    return String(obj);
+                }
+            },
+            defer: function(fn) {
+                setTimeout(fn, 0);
+            },
+            debounce: function(func, wait, immediate) {
+                var timeout, result;
+                return function() {
+                    var context = this, args = arguments, later, callNow;
+                    later = function() {
+                        timeout = null;
+                        if (!immediate) {
+                            result = func.apply(context, args);
+                        }
+                    };
+                    callNow = immediate && !timeout;
+                    clearTimeout(timeout);
+                    timeout = setTimeout(later, wait);
+                    if (callNow) {
+                        result = func.apply(context, args);
+                    }
+                    return result;
+                };
+            },
+            throttle: function(func, wait) {
+                var context, args, timeout, result, previous, later;
+                previous = 0;
+                later = function() {
+                    previous = new Date();
+                    timeout = null;
+                    result = func.apply(context, args);
+                };
+                return function() {
+                    var now = new Date(), remaining = wait - (now - previous);
+                    context = this;
+                    args = arguments;
+                    if (remaining <= 0) {
+                        clearTimeout(timeout);
+                        timeout = null;
+                        previous = now;
+                        result = func.apply(context, args);
+                    } else if (!timeout) {
+                        timeout = setTimeout(later, remaining);
+                    }
+                    return result;
+                };
+            },
+            stringify: function(val) {
+                return _.isString(val) ? val : JSON.stringify(val);
+            },
+            guid: function() {
+                function _p8(s) {
+                    var p = (Math.random().toString(16) + "000000000").substr(2, 8);
+                    return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p;
+                }
+                return "tt-" + _p8() + _p8(true) + _p8(true) + _p8();
+            },
+            noop: function() {}
+        };
+    }();
+    var WWW = function() {
+        "use strict";
+        var defaultClassNames = {
+            wrapper: "twitter-typeahead",
+            input: "tt-input",
+            hint: "tt-hint",
+            menu: "tt-menu",
+            dataset: "tt-dataset",
+            suggestion: "tt-suggestion",
+            selectable: "tt-selectable",
+            empty: "tt-empty",
+            open: "tt-open",
+            cursor: "tt-cursor",
+            highlight: "tt-highlight"
+        };
+        return build;
+        function build(o) {
+            var www, classes;
+            classes = _.mixin({}, defaultClassNames, o);
+            www = {
+                css: buildCss(),
+                classes: classes,
+                html: buildHtml(classes),
+                selectors: buildSelectors(classes)
+            };
+            return {
+                css: www.css,
+                html: www.html,
+                classes: www.classes,
+                selectors: www.selectors,
+                mixin: function(o) {
+                    _.mixin(o, www);
+                }
+            };
+        }
+        function buildHtml(c) {
+            return {
+                wrapper: '',
+                menu: '
                                                                                                                                                                                          '
+            };
+        }
+        function buildSelectors(classes) {
+            var selectors = {};
+            _.each(classes, function(v, k) {
+                selectors[k] = "." + v;
+            });
+            return selectors;
+        }
+        function buildCss() {
+            var css = {
+                wrapper: {
+                    position: "relative",
+                    display: "inline-block"
+                },
+                hint: {
+                    position: "absolute",
+                    top: "0",
+                    left: "0",
+                    borderColor: "transparent",
+                    boxShadow: "none",
+                    opacity: "1"
+                },
+                input: {
+                    position: "relative",
+                    verticalAlign: "top",
+                    backgroundColor: "transparent"
+                },
+                inputWithNoHint: {
+                    position: "relative",
+                    verticalAlign: "top"
+                },
+                menu: {
+                    position: "absolute",
+                    top: "100%",
+                    left: "0",
+                    zIndex: "100",
+                    display: "none"
+                },
+                ltr: {
+                    left: "0",
+                    right: "auto"
+                },
+                rtl: {
+                    left: "auto",
+                    right: " 0"
+                }
+            };
+            if (_.isMsie()) {
+                _.mixin(css.input, {
+                    backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)"
+                });
+            }
+            return css;
+        }
+    }();
+    var EventBus = function() {
+        "use strict";
+        var namespace, deprecationMap;
+        namespace = "typeahead:";
+        deprecationMap = {
+            render: "rendered",
+            cursorchange: "cursorchanged",
+            select: "selected",
+            autocomplete: "autocompleted"
+        };
+        function EventBus(o) {
+            if (!o || !o.el) {
+                $.error("EventBus initialized without el");
+            }
+            this.$el = $(o.el);
+        }
+        _.mixin(EventBus.prototype, {
+            _trigger: function(type, args) {
+                var $e = $.Event(namespace + type);
+                this.$el.trigger.call(this.$el, $e, args || []);
+                return $e;
+            },
+            before: function(type) {
+                var args, $e;
+                args = [].slice.call(arguments, 1);
+                $e = this._trigger("before" + type, args);
+                return $e.isDefaultPrevented();
+            },
+            trigger: function(type) {
+                var deprecatedType;
+                this._trigger(type, [].slice.call(arguments, 1));
+                if (deprecatedType = deprecationMap[type]) {
+                    this._trigger(deprecatedType, [].slice.call(arguments, 1));
+                }
+            }
+        });
+        return EventBus;
+    }();
+    var EventEmitter = function() {
+        "use strict";
+        var splitter = /\s+/, nextTick = getNextTick();
+        return {
+            onSync: onSync,
+            onAsync: onAsync,
+            off: off,
+            trigger: trigger
+        };
+        function on(method, types, cb, context) {
+            var type;
+            if (!cb) {
+                return this;
+            }
+            types = types.split(splitter);
+            cb = context ? bindContext(cb, context) : cb;
+            this._callbacks = this._callbacks || {};
+            while (type = types.shift()) {
+                this._callbacks[type] = this._callbacks[type] || {
+                    sync: [],
+                    async: []
+                };
+                this._callbacks[type][method].push(cb);
+            }
+            return this;
+        }
+        function onAsync(types, cb, context) {
+            return on.call(this, "async", types, cb, context);
+        }
+        function onSync(types, cb, context) {
+            return on.call(this, "sync", types, cb, context);
+        }
+        function off(types) {
+            var type;
+            if (!this._callbacks) {
+                return this;
+            }
+            types = types.split(splitter);
+            while (type = types.shift()) {
+                delete this._callbacks[type];
+            }
+            return this;
+        }
+        function trigger(types) {
+            var type, callbacks, args, syncFlush, asyncFlush;
+            if (!this._callbacks) {
+                return this;
+            }
+            types = types.split(splitter);
+            args = [].slice.call(arguments, 1);
+            while ((type = types.shift()) && (callbacks = this._callbacks[type])) {
+                syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args));
+                asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args));
+                syncFlush() && nextTick(asyncFlush);
+            }
+            return this;
+        }
+        function getFlush(callbacks, context, args) {
+            return flush;
+            function flush() {
+                var cancelled;
+                for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) {
+                    cancelled = callbacks[i].apply(context, args) === false;
+                }
+                return !cancelled;
+            }
+        }
+        function getNextTick() {
+            var nextTickFn;
+            if (window.setImmediate) {
+                nextTickFn = function nextTickSetImmediate(fn) {
+                    setImmediate(function() {
+                        fn();
+                    });
+                };
+            } else {
+                nextTickFn = function nextTickSetTimeout(fn) {
+                    setTimeout(function() {
+                        fn();
+                    }, 0);
+                };
+            }
+            return nextTickFn;
+        }
+        function bindContext(fn, context) {
+            return fn.bind ? fn.bind(context) : function() {
+                fn.apply(context, [].slice.call(arguments, 0));
+            };
+        }
+    }();
+    var highlight = function(doc) {
+        "use strict";
+        var defaults = {
+            node: null,
+            pattern: null,
+            tagName: "strong",
+            className: null,
+            wordsOnly: false,
+            caseSensitive: false,
+            diacriticInsensitive: false
+        };
+        var accented = {
+            A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Ａａ]",
+            B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Ｂｂ]",
+            C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Ｃｃ]",
+            D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Ｄｄ]",
+            E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ｅｅ]",
+            F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflＦｆ]",
+            G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Ｇｇ]",
+            H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Ｈｈ]",
+            I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiＩｉ]",
+            J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼＪｊ]",
+            K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Ｋｋ]",
+            L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflＬｌ]",
+            M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Ｍｍ]",
+            N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Ｎｎ]",
+            O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Ｏｏ]",
+            P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Ｐｐ]",
+            Q: "[Qqℚ⒬Ⓠⓠ㏃Ｑｑ]",
+            R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Ｒｒ]",
+            S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stＳｓ]",
+            T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstＴｔ]",
+            U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Ｕｕ]",
+            V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Ｖｖ]",
+            W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ｗｗ]",
+            X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Ｘｘ]",
+            Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Ｙｙ]",
+            Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Ｚｚ]"
+        };
+        return function hightlight(o) {
+            var regex;
+            o = _.mixin({}, defaults, o);
+            if (!o.node || !o.pattern) {
+                return;
+            }
+            o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ];
+            regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive);
+            traverse(o.node, hightlightTextNode);
+            function hightlightTextNode(textNode) {
+                var match, patternNode, wrapperNode;
+                if (match = regex.exec(textNode.data)) {
+                    wrapperNode = doc.createElement(o.tagName);
+                    o.className && (wrapperNode.className = o.className);
+                    patternNode = textNode.splitText(match.index);
+                    patternNode.splitText(match[0].length);
+                    wrapperNode.appendChild(patternNode.cloneNode(true));
+                    textNode.parentNode.replaceChild(wrapperNode, patternNode);
+                }
+                return !!match;
+            }
+            function traverse(el, hightlightTextNode) {
+                var childNode, TEXT_NODE_TYPE = 3;
+                for (var i = 0; i < el.childNodes.length; i++) {
+                    childNode = el.childNodes[i];
+                    if (childNode.nodeType === TEXT_NODE_TYPE) {
+                        i += hightlightTextNode(childNode) ? 1 : 0;
+                    } else {
+                        traverse(childNode, hightlightTextNode);
+                    }
+                }
+            }
+        };
+        function accent_replacer(chr) {
+            return accented[chr.toUpperCase()] || chr;
+        }
+        function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) {
+            var escapedPatterns = [], regexStr;
+            for (var i = 0, len = patterns.length; i < len; i++) {
+                var escapedWord = _.escapeRegExChars(patterns[i]);
+                if (diacriticInsensitive) {
+                    escapedWord = escapedWord.replace(/\S/g, accent_replacer);
+                }
+                escapedPatterns.push(escapedWord);
+            }
+            regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")";
+            return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i");
+        }
+    }(window.document);
+    var Input = function() {
+        "use strict";
+        var specialKeyCodeMap;
+        specialKeyCodeMap = {
+            9: "tab",
+            27: "esc",
+            37: "left",
+            39: "right",
+            13: "enter",
+            38: "up",
+            40: "down"
+        };
+        function Input(o, www) {
+            var id;
+            o = o || {};
+            if (!o.input) {
+                $.error("input is missing");
+            }
+            www.mixin(this);
+            this.$hint = $(o.hint);
+            this.$input = $(o.input);
+            this.$menu = $(o.menu);
+            id = this.$input.attr("id") || _.guid();
+            this.$menu.attr("id", id + "_listbox");
+            this.$hint.attr({
+                "aria-hidden": true
+            });
+            this.$input.attr({
+                "aria-owns": id + "_listbox",
+                role: "combobox",
+                "aria-autocomplete": "list",
+                "aria-expanded": false
+            });
+            this.query = this.$input.val();
+            this.queryWhenFocused = this.hasFocus() ? this.query : null;
+            this.$overflowHelper = buildOverflowHelper(this.$input);
+            this._checkLanguageDirection();
+            if (this.$hint.length === 0) {
+                this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop;
+            }
+            this.onSync("cursorchange", this._updateDescendent);
+        }
+        Input.normalizeQuery = function(str) {
+            return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " ");
+        };
+        _.mixin(Input.prototype, EventEmitter, {
+            _onBlur: function onBlur() {
+                this.resetInputValue();
+                this.trigger("blurred");
+            },
+            _onFocus: function onFocus() {
+                this.queryWhenFocused = this.query;
+                this.trigger("focused");
+            },
+            _onKeydown: function onKeydown($e) {
+                var keyName = specialKeyCodeMap[$e.which || $e.keyCode];
+                this._managePreventDefault(keyName, $e);
+                if (keyName && this._shouldTrigger(keyName, $e)) {
+                    this.trigger(keyName + "Keyed", $e);
+                }
+            },
+            _onInput: function onInput() {
+                this._setQuery(this.getInputValue());
+                this.clearHintIfInvalid();
+                this._checkLanguageDirection();
+            },
+            _managePreventDefault: function managePreventDefault(keyName, $e) {
+                var preventDefault;
+                switch (keyName) {
+                  case "up":
+                  case "down":
+                    preventDefault = !withModifier($e);
+                    break;
+
+                  default:
+                    preventDefault = false;
+                }
+                preventDefault && $e.preventDefault();
+            },
+            _shouldTrigger: function shouldTrigger(keyName, $e) {
+                var trigger;
+                switch (keyName) {
+                  case "tab":
+                    trigger = !withModifier($e);
+                    break;
+
+                  default:
+                    trigger = true;
+                }
+                return trigger;
+            },
+            _checkLanguageDirection: function checkLanguageDirection() {
+                var dir = (this.$input.css("direction") || "ltr").toLowerCase();
+                if (this.dir !== dir) {
+                    this.dir = dir;
+                    this.$hint.attr("dir", dir);
+                    this.trigger("langDirChanged", dir);
+                }
+            },
+            _setQuery: function setQuery(val, silent) {
+                var areEquivalent, hasDifferentWhitespace;
+                areEquivalent = areQueriesEquivalent(val, this.query);
+                hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false;
+                this.query = val;
+                if (!silent && !areEquivalent) {
+                    this.trigger("queryChanged", this.query);
+                } else if (!silent && hasDifferentWhitespace) {
+                    this.trigger("whitespaceChanged", this.query);
+                }
+            },
+            _updateDescendent: function updateDescendent(event, id) {
+                this.$input.attr("aria-activedescendant", id);
+            },
+            bind: function() {
+                var that = this, onBlur, onFocus, onKeydown, onInput;
+                onBlur = _.bind(this._onBlur, this);
+                onFocus = _.bind(this._onFocus, this);
+                onKeydown = _.bind(this._onKeydown, this);
+                onInput = _.bind(this._onInput, this);
+                this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown);
+                if (!_.isMsie() || _.isMsie() > 9) {
+                    this.$input.on("input.tt", onInput);
+                } else {
+                    this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) {
+                        if (specialKeyCodeMap[$e.which || $e.keyCode]) {
+                            return;
+                        }
+                        _.defer(_.bind(that._onInput, that, $e));
+                    });
+                }
+                return this;
+            },
+            focus: function focus() {
+                this.$input.focus();
+            },
+            blur: function blur() {
+                this.$input.blur();
+            },
+            getLangDir: function getLangDir() {
+                return this.dir;
+            },
+            getQuery: function getQuery() {
+                return this.query || "";
+            },
+            setQuery: function setQuery(val, silent) {
+                this.setInputValue(val);
+                this._setQuery(val, silent);
+            },
+            hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() {
+                return this.query !== this.queryWhenFocused;
+            },
+            getInputValue: function getInputValue() {
+                return this.$input.val();
+            },
+            setInputValue: function setInputValue(value) {
+                this.$input.val(value);
+                this.clearHintIfInvalid();
+                this._checkLanguageDirection();
+            },
+            resetInputValue: function resetInputValue() {
+                this.setInputValue(this.query);
+            },
+            getHint: function getHint() {
+                return this.$hint.val();
+            },
+            setHint: function setHint(value) {
+                this.$hint.val(value);
+            },
+            clearHint: function clearHint() {
+                this.setHint("");
+            },
+            clearHintIfInvalid: function clearHintIfInvalid() {
+                var val, hint, valIsPrefixOfHint, isValid;
+                val = this.getInputValue();
+                hint = this.getHint();
+                valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0;
+                isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow();
+                !isValid && this.clearHint();
+            },
+            hasFocus: function hasFocus() {
+                return this.$input.is(":focus");
+            },
+            hasOverflow: function hasOverflow() {
+                var constraint = this.$input.width() - 2;
+                this.$overflowHelper.text(this.getInputValue());
+                return this.$overflowHelper.width() >= constraint;
+            },
+            isCursorAtEnd: function() {
+                var valueLength, selectionStart, range;
+                valueLength = this.$input.val().length;
+                selectionStart = this.$input[0].selectionStart;
+                if (_.isNumber(selectionStart)) {
+                    return selectionStart === valueLength;
+                } else if (document.selection) {
+                    range = document.selection.createRange();
+                    range.moveStart("character", -valueLength);
+                    return valueLength === range.text.length;
+                }
+                return true;
+            },
+            destroy: function destroy() {
+                this.$hint.off(".tt");
+                this.$input.off(".tt");
+                this.$overflowHelper.remove();
+                this.$hint = this.$input = this.$overflowHelper = $("
                                                                                                                                                                                          ");
+            },
+            setAriaExpanded: function setAriaExpanded(value) {
+                this.$input.attr("aria-expanded", value);
+            }
+        });
+        return Input;
+        function buildOverflowHelper($input) {
+            return $('').css({
+                position: "absolute",
+                visibility: "hidden",
+                whiteSpace: "pre",
+                fontFamily: $input.css("font-family"),
+                fontSize: $input.css("font-size"),
+                fontStyle: $input.css("font-style"),
+                fontVariant: $input.css("font-variant"),
+                fontWeight: $input.css("font-weight"),
+                wordSpacing: $input.css("word-spacing"),
+                letterSpacing: $input.css("letter-spacing"),
+                textIndent: $input.css("text-indent"),
+                textRendering: $input.css("text-rendering"),
+                textTransform: $input.css("text-transform")
+            }).insertAfter($input);
+        }
+        function areQueriesEquivalent(a, b) {
+            return Input.normalizeQuery(a) === Input.normalizeQuery(b);
+        }
+        function withModifier($e) {
+            return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey;
+        }
+    }();
+    var Dataset = function() {
+        "use strict";
+        var keys, nameGenerator;
+        keys = {
+            dataset: "tt-selectable-dataset",
+            val: "tt-selectable-display",
+            obj: "tt-selectable-object"
+        };
+        nameGenerator = _.getIdGenerator();
+        function Dataset(o, www) {
+            o = o || {};
+            o.templates = o.templates || {};
+            o.templates.notFound = o.templates.notFound || o.templates.empty;
+            if (!o.source) {
+                $.error("missing source");
+            }
+            if (!o.node) {
+                $.error("missing node");
+            }
+            if (o.name && !isValidName(o.name)) {
+                $.error("invalid dataset name: " + o.name);
+            }
+            www.mixin(this);
+            this.highlight = !!o.highlight;
+            this.name = _.toStr(o.name || nameGenerator());
+            this.limit = o.limit || 5;
+            this.displayFn = getDisplayFn(o.display || o.displayKey);
+            this.templates = getTemplates(o.templates, this.displayFn);
+            this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source;
+            this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async;
+            this._resetLastSuggestion();
+            this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name);
+        }
+        Dataset.extractData = function extractData(el) {
+            var $el = $(el);
+            if ($el.data(keys.obj)) {
+                return {
+                    dataset: $el.data(keys.dataset) || "",
+                    val: $el.data(keys.val) || "",
+                    obj: $el.data(keys.obj) || null
+                };
+            }
+            return null;
+        };
+        _.mixin(Dataset.prototype, EventEmitter, {
+            _overwrite: function overwrite(query, suggestions) {
+                suggestions = suggestions || [];
+                if (suggestions.length) {
+                    this._renderSuggestions(query, suggestions);
+                } else if (this.async && this.templates.pending) {
+                    this._renderPending(query);
+                } else if (!this.async && this.templates.notFound) {
+                    this._renderNotFound(query);
+                } else {
+                    this._empty();
+                }
+                this.trigger("rendered", suggestions, false, this.name);
+            },
+            _append: function append(query, suggestions) {
+                suggestions = suggestions || [];
+                if (suggestions.length && this.$lastSuggestion.length) {
+                    this._appendSuggestions(query, suggestions);
+                } else if (suggestions.length) {
+                    this._renderSuggestions(query, suggestions);
+                } else if (!this.$lastSuggestion.length && this.templates.notFound) {
+                    this._renderNotFound(query);
+                }
+                this.trigger("rendered", suggestions, true, this.name);
+            },
+            _renderSuggestions: function renderSuggestions(query, suggestions) {
+                var $fragment;
+                $fragment = this._getSuggestionsFragment(query, suggestions);
+                this.$lastSuggestion = $fragment.children().last();
+                this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions));
+            },
+            _appendSuggestions: function appendSuggestions(query, suggestions) {
+                var $fragment, $lastSuggestion;
+                $fragment = this._getSuggestionsFragment(query, suggestions);
+                $lastSuggestion = $fragment.children().last();
+                this.$lastSuggestion.after($fragment);
+                this.$lastSuggestion = $lastSuggestion;
+            },
+            _renderPending: function renderPending(query) {
+                var template = this.templates.pending;
+                this._resetLastSuggestion();
+                template && this.$el.html(template({
+                    query: query,
+                    dataset: this.name
+                }));
+            },
+            _renderNotFound: function renderNotFound(query) {
+                var template = this.templates.notFound;
+                this._resetLastSuggestion();
+                template && this.$el.html(template({
+                    query: query,
+                    dataset: this.name
+                }));
+            },
+            _empty: function empty() {
+                this.$el.empty();
+                this._resetLastSuggestion();
+            },
+            _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) {
+                var that = this, fragment;
+                fragment = document.createDocumentFragment();
+                _.each(suggestions, function getSuggestionNode(suggestion) {
+                    var $el, context;
+                    context = that._injectQuery(query, suggestion);
+                    $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable);
+                    fragment.appendChild($el[0]);
+                });
+                this.highlight && highlight({
+                    className: this.classes.highlight,
+                    node: fragment,
+                    pattern: query
+                });
+                return $(fragment);
+            },
+            _getFooter: function getFooter(query, suggestions) {
+                return this.templates.footer ? this.templates.footer({
+                    query: query,
+                    suggestions: suggestions,
+                    dataset: this.name
+                }) : null;
+            },
+            _getHeader: function getHeader(query, suggestions) {
+                return this.templates.header ? this.templates.header({
+                    query: query,
+                    suggestions: suggestions,
+                    dataset: this.name
+                }) : null;
+            },
+            _resetLastSuggestion: function resetLastSuggestion() {
+                this.$lastSuggestion = $();
+            },
+            _injectQuery: function injectQuery(query, obj) {
+                return _.isObject(obj) ? _.mixin({
+                    _query: query
+                }, obj) : obj;
+            },
+            update: function update(query) {
+                var that = this, canceled = false, syncCalled = false, rendered = 0;
+                this.cancel();
+                this.cancel = function cancel() {
+                    canceled = true;
+                    that.cancel = $.noop;
+                    that.async && that.trigger("asyncCanceled", query, that.name);
+                };
+                this.source(query, sync, async);
+                !syncCalled && sync([]);
+                function sync(suggestions) {
+                    if (syncCalled) {
+                        return;
+                    }
+                    syncCalled = true;
+                    suggestions = (suggestions || []).slice(0, that.limit);
+                    rendered = suggestions.length;
+                    that._overwrite(query, suggestions);
+                    if (rendered < that.limit && that.async) {
+                        that.trigger("asyncRequested", query, that.name);
+                    }
+                }
+                function async(suggestions) {
+                    suggestions = suggestions || [];
+                    if (!canceled && rendered < that.limit) {
+                        that.cancel = $.noop;
+                        var idx = Math.abs(rendered - that.limit);
+                        rendered += idx;
+                        that._append(query, suggestions.slice(0, idx));
+                        that.async && that.trigger("asyncReceived", query, that.name);
+                    }
+                }
+            },
+            cancel: $.noop,
+            clear: function clear() {
+                this._empty();
+                this.cancel();
+                this.trigger("cleared");
+            },
+            isEmpty: function isEmpty() {
+                return this.$el.is(":empty");
+            },
+            destroy: function destroy() {
+                this.$el = $("
                                                                                                                                                                                          ");
+            }
+        });
+        return Dataset;
+        function getDisplayFn(display) {
+            display = display || _.stringify;
+            return _.isFunction(display) ? display : displayFn;
+            function displayFn(obj) {
+                return obj[display];
+            }
+        }
+        function getTemplates(templates, displayFn) {
+            return {
+                notFound: templates.notFound && _.templatify(templates.notFound),
+                pending: templates.pending && _.templatify(templates.pending),
+                header: templates.header && _.templatify(templates.header),
+                footer: templates.footer && _.templatify(templates.footer),
+                suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate
+            };
+            function userSuggestionTemplate(context) {
+                var template = templates.suggestion;
+                return $(template(context)).attr("id", _.guid());
+            }
+            function suggestionTemplate(context) {
+                return $('
                                                                                                                                                                                          ').attr("id", _.guid()).text(displayFn(context));
+            }
+        }
+        function isValidName(str) {
+            return /^[_a-zA-Z0-9-]+$/.test(str);
+        }
+    }();
+    var Menu = function() {
+        "use strict";
+        function Menu(o, www) {
+            var that = this;
+            o = o || {};
+            if (!o.node) {
+                $.error("node is required");
+            }
+            www.mixin(this);
+            this.$node = $(o.node);
+            this.query = null;
+            this.datasets = _.map(o.datasets, initializeDataset);
+            function initializeDataset(oDataset) {
+                var node = that.$node.find(oDataset.node).first();
+                oDataset.node = node.length ? node : $("
                                                                                                                                                                                          ").appendTo(that.$node);
+                return new Dataset(oDataset, www);
+            }
+        }
+        _.mixin(Menu.prototype, EventEmitter, {
+            _onSelectableClick: function onSelectableClick($e) {
+                this.trigger("selectableClicked", $($e.currentTarget));
+            },
+            _onRendered: function onRendered(type, dataset, suggestions, async) {
+                this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty());
+                this.trigger("datasetRendered", dataset, suggestions, async);
+            },
+            _onCleared: function onCleared() {
+                this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty());
+                this.trigger("datasetCleared");
+            },
+            _propagate: function propagate() {
+                this.trigger.apply(this, arguments);
+            },
+            _allDatasetsEmpty: function allDatasetsEmpty() {
+                return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) {
+                    var isEmpty = dataset.isEmpty();
+                    this.$node.attr("aria-expanded", !isEmpty);
+                    return isEmpty;
+                }, this));
+            },
+            _getSelectables: function getSelectables() {
+                return this.$node.find(this.selectors.selectable);
+            },
+            _removeCursor: function _removeCursor() {
+                var $selectable = this.getActiveSelectable();
+                $selectable && $selectable.removeClass(this.classes.cursor);
+            },
+            _ensureVisible: function ensureVisible($el) {
+                var elTop, elBottom, nodeScrollTop, nodeHeight;
+                elTop = $el.position().top;
+                elBottom = elTop + $el.outerHeight(true);
+                nodeScrollTop = this.$node.scrollTop();
+                nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10);
+                if (elTop < 0) {
+                    this.$node.scrollTop(nodeScrollTop + elTop);
+                } else if (nodeHeight < elBottom) {
+                    this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight));
+                }
+            },
+            bind: function() {
+                var that = this, onSelectableClick;
+                onSelectableClick = _.bind(this._onSelectableClick, this);
+                this.$node.on("click.tt", this.selectors.selectable, onSelectableClick);
+                this.$node.on("mouseover", this.selectors.selectable, function() {
+                    that.setCursor($(this));
+                });
+                this.$node.on("mouseleave", function() {
+                    that._removeCursor();
+                });
+                _.each(this.datasets, function(dataset) {
+                    dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that);
+                });
+                return this;
+            },
+            isOpen: function isOpen() {
+                return this.$node.hasClass(this.classes.open);
+            },
+            open: function open() {
+                this.$node.scrollTop(0);
+                this.$node.addClass(this.classes.open);
+            },
+            close: function close() {
+                this.$node.attr("aria-expanded", false);
+                this.$node.removeClass(this.classes.open);
+                this._removeCursor();
+            },
+            setLanguageDirection: function setLanguageDirection(dir) {
+                this.$node.attr("dir", dir);
+            },
+            selectableRelativeToCursor: function selectableRelativeToCursor(delta) {
+                var $selectables, $oldCursor, oldIndex, newIndex;
+                $oldCursor = this.getActiveSelectable();
+                $selectables = this._getSelectables();
+                oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1;
+                newIndex = oldIndex + delta;
+                newIndex = (newIndex + 1) % ($selectables.length + 1) - 1;
+                newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex;
+                return newIndex === -1 ? null : $selectables.eq(newIndex);
+            },
+            setCursor: function setCursor($selectable) {
+                this._removeCursor();
+                if ($selectable = $selectable && $selectable.first()) {
+                    $selectable.addClass(this.classes.cursor);
+                    this._ensureVisible($selectable);
+                }
+            },
+            getSelectableData: function getSelectableData($el) {
+                return $el && $el.length ? Dataset.extractData($el) : null;
+            },
+            getActiveSelectable: function getActiveSelectable() {
+                var $selectable = this._getSelectables().filter(this.selectors.cursor).first();
+                return $selectable.length ? $selectable : null;
+            },
+            getTopSelectable: function getTopSelectable() {
+                var $selectable = this._getSelectables().first();
+                return $selectable.length ? $selectable : null;
+            },
+            update: function update(query) {
+                var isValidUpdate = query !== this.query;
+                if (isValidUpdate) {
+                    this.query = query;
+                    _.each(this.datasets, updateDataset);
+                }
+                return isValidUpdate;
+                function updateDataset(dataset) {
+                    dataset.update(query);
+                }
+            },
+            empty: function empty() {
+                _.each(this.datasets, clearDataset);
+                this.query = null;
+                this.$node.addClass(this.classes.empty);
+                function clearDataset(dataset) {
+                    dataset.clear();
+                }
+            },
+            destroy: function destroy() {
+                this.$node.off(".tt");
+                this.$node = $("
                                                                                                                                                                                          ");
+                _.each(this.datasets, destroyDataset);
+                function destroyDataset(dataset) {
+                    dataset.destroy();
+                }
+            }
+        });
+        return Menu;
+    }();
+    var Status = function() {
+        "use strict";
+        function Status(options) {
+            this.$el = $("", {
+                role: "status",
+                "aria-live": "polite"
+            }).css({
+                position: "absolute",
+                padding: "0",
+                border: "0",
+                height: "1px",
+                width: "1px",
+                "margin-bottom": "-1px",
+                "margin-right": "-1px",
+                overflow: "hidden",
+                clip: "rect(0 0 0 0)",
+                "white-space": "nowrap"
+            });
+            options.$input.after(this.$el);
+            _.each(options.menu.datasets, _.bind(function(dataset) {
+                if (dataset.onSync) {
+                    dataset.onSync("rendered", _.bind(this.update, this));
+                    dataset.onSync("cleared", _.bind(this.cleared, this));
+                }
+            }, this));
+        }
+        _.mixin(Status.prototype, {
+            update: function update(event, suggestions) {
+                var length = suggestions.length;
+                var words;
+                if (length === 1) {
+                    words = {
+                        result: "result",
+                        is: "is"
+                    };
+                } else {
+                    words = {
+                        result: "results",
+                        is: "are"
+                    };
+                }
+                this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate.");
+            },
+            cleared: function() {
+                this.$el.text("");
+            }
+        });
+        return Status;
+    }();
+    var DefaultMenu = function() {
+        "use strict";
+        var s = Menu.prototype;
+        function DefaultMenu() {
+            Menu.apply(this, [].slice.call(arguments, 0));
+        }
+        _.mixin(DefaultMenu.prototype, Menu.prototype, {
+            open: function open() {
+                !this._allDatasetsEmpty() && this._show();
+                return s.open.apply(this, [].slice.call(arguments, 0));
+            },
+            close: function close() {
+                this._hide();
+                return s.close.apply(this, [].slice.call(arguments, 0));
+            },
+            _onRendered: function onRendered() {
+                if (this._allDatasetsEmpty()) {
+                    this._hide();
+                } else {
+                    this.isOpen() && this._show();
+                }
+                return s._onRendered.apply(this, [].slice.call(arguments, 0));
+            },
+            _onCleared: function onCleared() {
+                if (this._allDatasetsEmpty()) {
+                    this._hide();
+                } else {
+                    this.isOpen() && this._show();
+                }
+                return s._onCleared.apply(this, [].slice.call(arguments, 0));
+            },
+            setLanguageDirection: function setLanguageDirection(dir) {
+                this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl);
+                return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0));
+            },
+            _hide: function hide() {
+                this.$node.hide();
+            },
+            _show: function show() {
+                this.$node.css("display", "block");
+            }
+        });
+        return DefaultMenu;
+    }();
+    var Typeahead = function() {
+        "use strict";
+        function Typeahead(o, www) {
+            var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged;
+            o = o || {};
+            if (!o.input) {
+                $.error("missing input");
+            }
+            if (!o.menu) {
+                $.error("missing menu");
+            }
+            if (!o.eventBus) {
+                $.error("missing event bus");
+            }
+            www.mixin(this);
+            this.eventBus = o.eventBus;
+            this.minLength = _.isNumber(o.minLength) ? o.minLength : 1;
+            this.input = o.input;
+            this.menu = o.menu;
+            this.enabled = true;
+            this.autoselect = !!o.autoselect;
+            this.active = false;
+            this.input.hasFocus() && this.activate();
+            this.dir = this.input.getLangDir();
+            this._hacks();
+            this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this);
+            onFocused = c(this, "activate", "open", "_onFocused");
+            onBlurred = c(this, "deactivate", "_onBlurred");
+            onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed");
+            onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed");
+            onEscKeyed = c(this, "isActive", "_onEscKeyed");
+            onUpKeyed = c(this, "isActive", "open", "_onUpKeyed");
+            onDownKeyed = c(this, "isActive", "open", "_onDownKeyed");
+            onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed");
+            onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed");
+            onQueryChanged = c(this, "_openIfActive", "_onQueryChanged");
+            onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged");
+            this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this);
+        }
+        _.mixin(Typeahead.prototype, {
+            _hacks: function hacks() {
+                var $input, $menu;
+                $input = this.input.$input || $("
                                                                                                                                                                                          ");
+                $menu = this.menu.$node || $("
                                                                                                                                                                                          ");
+                $input.on("blur.tt", function($e) {
+                    var active, isActive, hasActive;
+                    active = document.activeElement;
+                    isActive = $menu.is(active);
+                    hasActive = $menu.has(active).length > 0;
+                    if (_.isMsie() && (isActive || hasActive)) {
+                        $e.preventDefault();
+                        $e.stopImmediatePropagation();
+                        _.defer(function() {
+                            $input.focus();
+                        });
+                    }
+                });
+                $menu.on("mousedown.tt", function($e) {
+                    $e.preventDefault();
+                });
+            },
+            _onSelectableClicked: function onSelectableClicked(type, $el) {
+                this.select($el);
+            },
+            _onDatasetCleared: function onDatasetCleared() {
+                this._updateHint();
+            },
+            _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) {
+                this._updateHint();
+                if (this.autoselect) {
+                    var cursorClass = this.selectors.cursor.substr(1);
+                    this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass);
+                }
+                this.eventBus.trigger("render", suggestions, async, dataset);
+            },
+            _onAsyncRequested: function onAsyncRequested(type, dataset, query) {
+                this.eventBus.trigger("asyncrequest", query, dataset);
+            },
+            _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) {
+                this.eventBus.trigger("asynccancel", query, dataset);
+            },
+            _onAsyncReceived: function onAsyncReceived(type, dataset, query) {
+                this.eventBus.trigger("asyncreceive", query, dataset);
+            },
+            _onFocused: function onFocused() {
+                this._minLengthMet() && this.menu.update(this.input.getQuery());
+            },
+            _onBlurred: function onBlurred() {
+                if (this.input.hasQueryChangedSinceLastFocus()) {
+                    this.eventBus.trigger("change", this.input.getQuery());
+                }
+            },
+            _onEnterKeyed: function onEnterKeyed(type, $e) {
+                var $selectable;
+                if ($selectable = this.menu.getActiveSelectable()) {
+                    if (this.select($selectable)) {
+                        $e.preventDefault();
+                        $e.stopPropagation();
+                    }
+                } else if (this.autoselect) {
+                    if (this.select(this.menu.getTopSelectable())) {
+                        $e.preventDefault();
+                        $e.stopPropagation();
+                    }
+                }
+            },
+            _onTabKeyed: function onTabKeyed(type, $e) {
+                var $selectable;
+                if ($selectable = this.menu.getActiveSelectable()) {
+                    this.select($selectable) && $e.preventDefault();
+                } else if (this.autoselect) {
+                    if ($selectable = this.menu.getTopSelectable()) {
+                        this.autocomplete($selectable) && $e.preventDefault();
+                    }
+                }
+            },
+            _onEscKeyed: function onEscKeyed() {
+                this.close();
+            },
+            _onUpKeyed: function onUpKeyed() {
+                this.moveCursor(-1);
+            },
+            _onDownKeyed: function onDownKeyed() {
+                this.moveCursor(+1);
+            },
+            _onLeftKeyed: function onLeftKeyed() {
+                if (this.dir === "rtl" && this.input.isCursorAtEnd()) {
+                    this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable());
+                }
+            },
+            _onRightKeyed: function onRightKeyed() {
+                if (this.dir === "ltr" && this.input.isCursorAtEnd()) {
+                    this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable());
+                }
+            },
+            _onQueryChanged: function onQueryChanged(e, query) {
+                this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty();
+            },
+            _onWhitespaceChanged: function onWhitespaceChanged() {
+                this._updateHint();
+            },
+            _onLangDirChanged: function onLangDirChanged(e, dir) {
+                if (this.dir !== dir) {
+                    this.dir = dir;
+                    this.menu.setLanguageDirection(dir);
+                }
+            },
+            _openIfActive: function openIfActive() {
+                this.isActive() && this.open();
+            },
+            _minLengthMet: function minLengthMet(query) {
+                query = _.isString(query) ? query : this.input.getQuery() || "";
+                return query.length >= this.minLength;
+            },
+            _updateHint: function updateHint() {
+                var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match;
+                $selectable = this.menu.getTopSelectable();
+                data = this.menu.getSelectableData($selectable);
+                val = this.input.getInputValue();
+                if (data && !_.isBlankString(val) && !this.input.hasOverflow()) {
+                    query = Input.normalizeQuery(val);
+                    escapedQuery = _.escapeRegExChars(query);
+                    frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i");
+                    match = frontMatchRegEx.exec(data.val);
+                    match && this.input.setHint(val + match[1]);
+                } else {
+                    this.input.clearHint();
+                }
+            },
+            isEnabled: function isEnabled() {
+                return this.enabled;
+            },
+            enable: function enable() {
+                this.enabled = true;
+            },
+            disable: function disable() {
+                this.enabled = false;
+            },
+            isActive: function isActive() {
+                return this.active;
+            },
+            activate: function activate() {
+                if (this.isActive()) {
+                    return true;
+                } else if (!this.isEnabled() || this.eventBus.before("active")) {
+                    return false;
+                } else {
+                    this.active = true;
+                    this.eventBus.trigger("active");
+                    return true;
+                }
+            },
+            deactivate: function deactivate() {
+                if (!this.isActive()) {
+                    return true;
+                } else if (this.eventBus.before("idle")) {
+                    return false;
+                } else {
+                    this.active = false;
+                    this.close();
+                    this.eventBus.trigger("idle");
+                    return true;
+                }
+            },
+            isOpen: function isOpen() {
+                return this.menu.isOpen();
+            },
+            open: function open() {
+                if (!this.isOpen() && !this.eventBus.before("open")) {
+                    this.input.setAriaExpanded(true);
+                    this.menu.open();
+                    this._updateHint();
+                    this.eventBus.trigger("open");
+                }
+                return this.isOpen();
+            },
+            close: function close() {
+                if (this.isOpen() && !this.eventBus.before("close")) {
+                    this.input.setAriaExpanded(false);
+                    this.menu.close();
+                    this.input.clearHint();
+                    this.input.resetInputValue();
+                    this.eventBus.trigger("close");
+                }
+                return !this.isOpen();
+            },
+            setVal: function setVal(val) {
+                this.input.setQuery(_.toStr(val));
+            },
+            getVal: function getVal() {
+                return this.input.getQuery();
+            },
+            select: function select($selectable) {
+                var data = this.menu.getSelectableData($selectable);
+                if (data && !this.eventBus.before("select", data.obj, data.dataset)) {
+                    this.input.setQuery(data.val, true);
+                    this.eventBus.trigger("select", data.obj, data.dataset);
+                    this.close();
+                    return true;
+                }
+                return false;
+            },
+            autocomplete: function autocomplete($selectable) {
+                var query, data, isValid;
+                query = this.input.getQuery();
+                data = this.menu.getSelectableData($selectable);
+                isValid = data && query !== data.val;
+                if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) {
+                    this.input.setQuery(data.val);
+                    this.eventBus.trigger("autocomplete", data.obj, data.dataset);
+                    return true;
+                }
+                return false;
+            },
+            moveCursor: function moveCursor(delta) {
+                var query, $candidate, data, suggestion, datasetName, cancelMove, id;
+                query = this.input.getQuery();
+                $candidate = this.menu.selectableRelativeToCursor(delta);
+                data = this.menu.getSelectableData($candidate);
+                suggestion = data ? data.obj : null;
+                datasetName = data ? data.dataset : null;
+                id = $candidate ? $candidate.attr("id") : null;
+                this.input.trigger("cursorchange", id);
+                cancelMove = this._minLengthMet() && this.menu.update(query);
+                if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) {
+                    this.menu.setCursor($candidate);
+                    if (data) {
+                        if (typeof data.val === "string") {
+                            this.input.setInputValue(data.val);
+                        }
+                    } else {
+                        this.input.resetInputValue();
+                        this._updateHint();
+                    }
+                    this.eventBus.trigger("cursorchange", suggestion, datasetName);
+                    return true;
+                }
+                return false;
+            },
+            destroy: function destroy() {
+                this.input.destroy();
+                this.menu.destroy();
+            }
+        });
+        return Typeahead;
+        function c(ctx) {
+            var methods = [].slice.call(arguments, 1);
+            return function() {
+                var args = [].slice.call(arguments);
+                _.each(methods, function(method) {
+                    return ctx[method].apply(ctx, args);
+                });
+            };
+        }
+    }();
+    (function() {
+        "use strict";
+        var old, keys, methods;
+        old = $.fn.typeahead;
+        keys = {
+            www: "tt-www",
+            attrs: "tt-attrs",
+            typeahead: "tt-typeahead"
+        };
+        methods = {
+            initialize: function initialize(o, datasets) {
+                var www;
+                datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1);
+                o = o || {};
+                www = WWW(o.classNames);
+                return this.each(attach);
+                function attach() {
+                    var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor;
+                    _.each(datasets, function(d) {
+                        d.highlight = !!o.highlight;
+                    });
+                    $input = $(this);
+                    $wrapper = $(www.html.wrapper);
+                    $hint = $elOrNull(o.hint);
+                    $menu = $elOrNull(o.menu);
+                    defaultHint = o.hint !== false && !$hint;
+                    defaultMenu = o.menu !== false && !$menu;
+                    defaultHint && ($hint = buildHintFromInput($input, www));
+                    defaultMenu && ($menu = $(www.html.menu).css(www.css.menu));
+                    $hint && $hint.val("");
+                    $input = prepInput($input, www);
+                    if (defaultHint || defaultMenu) {
+                        $wrapper.css(www.css.wrapper);
+                        $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint);
+                        $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null);
+                    }
+                    MenuConstructor = defaultMenu ? DefaultMenu : Menu;
+                    eventBus = new EventBus({
+                        el: $input
+                    });
+                    input = new Input({
+                        hint: $hint,
+                        input: $input,
+                        menu: $menu
+                    }, www);
+                    menu = new MenuConstructor({
+                        node: $menu,
+                        datasets: datasets
+                    }, www);
+                    status = new Status({
+                        $input: $input,
+                        menu: menu
+                    });
+                    typeahead = new Typeahead({
+                        input: input,
+                        menu: menu,
+                        eventBus: eventBus,
+                        minLength: o.minLength,
+                        autoselect: o.autoselect
+                    }, www);
+                    $input.data(keys.www, www);
+                    $input.data(keys.typeahead, typeahead);
+                }
+            },
+            isEnabled: function isEnabled() {
+                var enabled;
+                ttEach(this.first(), function(t) {
+                    enabled = t.isEnabled();
+                });
+                return enabled;
+            },
+            enable: function enable() {
+                ttEach(this, function(t) {
+                    t.enable();
+                });
+                return this;
+            },
+            disable: function disable() {
+                ttEach(this, function(t) {
+                    t.disable();
+                });
+                return this;
+            },
+            isActive: function isActive() {
+                var active;
+                ttEach(this.first(), function(t) {
+                    active = t.isActive();
+                });
+                return active;
+            },
+            activate: function activate() {
+                ttEach(this, function(t) {
+                    t.activate();
+                });
+                return this;
+            },
+            deactivate: function deactivate() {
+                ttEach(this, function(t) {
+                    t.deactivate();
+                });
+                return this;
+            },
+            isOpen: function isOpen() {
+                var open;
+                ttEach(this.first(), function(t) {
+                    open = t.isOpen();
+                });
+                return open;
+            },
+            open: function open() {
+                ttEach(this, function(t) {
+                    t.open();
+                });
+                return this;
+            },
+            close: function close() {
+                ttEach(this, function(t) {
+                    t.close();
+                });
+                return this;
+            },
+            select: function select(el) {
+                var success = false, $el = $(el);
+                ttEach(this.first(), function(t) {
+                    success = t.select($el);
+                });
+                return success;
+            },
+            autocomplete: function autocomplete(el) {
+                var success = false, $el = $(el);
+                ttEach(this.first(), function(t) {
+                    success = t.autocomplete($el);
+                });
+                return success;
+            },
+            moveCursor: function moveCursoe(delta) {
+                var success = false;
+                ttEach(this.first(), function(t) {
+                    success = t.moveCursor(delta);
+                });
+                return success;
+            },
+            val: function val(newVal) {
+                var query;
+                if (!arguments.length) {
+                    ttEach(this.first(), function(t) {
+                        query = t.getVal();
+                    });
+                    return query;
+                } else {
+                    ttEach(this, function(t) {
+                        t.setVal(_.toStr(newVal));
+                    });
+                    return this;
+                }
+            },
+            destroy: function destroy() {
+                ttEach(this, function(typeahead, $input) {
+                    revert($input);
+                    typeahead.destroy();
+                });
+                return this;
+            }
+        };
+        $.fn.typeahead = function(method) {
+            if (methods[method]) {
+                return methods[method].apply(this, [].slice.call(arguments, 1));
+            } else {
+                return methods.initialize.apply(this, arguments);
+            }
+        };
+        $.fn.typeahead.noConflict = function noConflict() {
+            $.fn.typeahead = old;
+            return this;
+        };
+        function ttEach($els, fn) {
+            $els.each(function() {
+                var $input = $(this), typeahead;
+                (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input);
+            });
+        }
+        function buildHintFromInput($input, www) {
+            return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({
+                readonly: true,
+                required: false
+            }).removeAttr("id name placeholder").removeClass("required").attr({
+                spellcheck: "false",
+                tabindex: -1
+            });
+        }
+        function prepInput($input, www) {
+            $input.data(keys.attrs, {
+                dir: $input.attr("dir"),
+                autocomplete: $input.attr("autocomplete"),
+                spellcheck: $input.attr("spellcheck"),
+                style: $input.attr("style")
+            });
+            $input.addClass(www.classes.input).attr({
+                spellcheck: false
+            });
+            try {
+                !$input.attr("dir") && $input.attr("dir", "auto");
+            } catch (e) {}
+            return $input;
+        }
+        function getBackgroundStyles($el) {
+            return {
+                backgroundAttachment: $el.css("background-attachment"),
+                backgroundClip: $el.css("background-clip"),
+                backgroundColor: $el.css("background-color"),
+                backgroundImage: $el.css("background-image"),
+                backgroundOrigin: $el.css("background-origin"),
+                backgroundPosition: $el.css("background-position"),
+                backgroundRepeat: $el.css("background-repeat"),
+                backgroundSize: $el.css("background-size")
+            };
+        }
+        function revert($input) {
+            var www, $wrapper;
+            www = $input.data(keys.www);
+            $wrapper = $input.parent().filter(www.selectors.wrapper);
+            _.each($input.data(keys.attrs), function(val, key) {
+                _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val);
+            });
+            $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input);
+            if ($wrapper.length) {
+                $input.detach().insertAfter($wrapper);
+                $wrapper.remove();
+            }
+        }
+        function $elOrNull(obj) {
+            var isValid, $el;
+            isValid = _.isJQuery(obj) || _.isElement(obj);
+            $el = isValid ? $(obj).first() : [];
+            return $el.length ? $el : null;
+        }
+    })();
+});
\ No newline at end of file
diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/search.json b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/search.json
index 62fcf68..673f164 100644
--- a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/search.json
+++ b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/Documents/search.json
@@ -1 +1 @@
-{"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV4nameSSSgvp":{"name":"name","abstract":"
                                                                                                                                                                                          The name of the voice; All AVSpeechSynthesisVoice instances have a persons name.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV8languageSSSgvp":{"name":"language","abstract":"
                                                                                                                                                                                          The name of the language being used.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV12languageCodeSSSgvp":{"name":"languageCode","abstract":"
                                                                                                                                                                                          The language code is what is internationally used in Locale settings.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV10identifierypSgvp":{"name":"identifier","abstract":"
                                                                                                                                                                                          Identifier is a unique bundle url provided by Apple for each AVSpeechSynthesisVoice.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html":{"name":"OSSVoiceInfo","abstract":"
                                                                                                                                                                                          The voice infor struct ensures that the data structure has conformity and consistency.
                                                                                                                                                                                          "},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP18didFinishListening8withTextySS_tF":{"name":"didFinishListening(withText:)","abstract":"
                                                                                                                                                                                          When the microphone has finished accepting audio, this delegate will be called with the final best text output.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP25authorizationToMicrophone18withAuthenticationyAA0aB19AuthorizationStatusO_tF":{"name":"authorizationToMicrophone(withAuthentication:)","abstract":"
                                                                                                                                                                                          Handle returning authentication status to user - primary use is for non-authorized state.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP32didFailToCommenceSpeechRecordingyyF":{"name":"didFailToCommenceSpeechRecording()","abstract":"
                                                                                                                                                                                          If the speech recogniser and request fail to set up, this method will be called.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP22didCompleteTranslation8withTextySS_tF":{"name":"didCompleteTranslation(withText:)","abstract":"
                                                                                                                                                                                          Method for real time recpetion of translated text.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP23didFailToProcessRequest9withErrorys0J0_pSg_tF":{"name":"didFailToProcessRequest(withError:)","abstract":"
                                                                                                                                                                                          Error handling function.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html":{"name":"OSSSpeechDelegate","abstract":"
                                                                                                                                                                                          Delegate to handle events such as failed authentication for microphone among many more.
                                                                                                                                                                                          "},"Extensions/Bundle.html#/s:So8NSBundleC12OSSSpeechKitE18getResourcesBundleABSgyFZ":{"name":"getResourcesBundle()","abstract":"
                                                                                                                                                                                          Will return the Bundle for the SDK if it can be found.
                                                                                                                                                                                          ","parent_name":"Bundle"},"Extensions/NSObject.html#/s:So8NSObjectC12OSSSpeechKitE8debugLog6object12functionName04fileH010lineNumber7messageyyp_S2SSiSStF":{"name":"debugLog(object:functionName:fileName:lineNumber:message:)","abstract":"
                                                                                                                                                                                          Method outputs a debug statement containing necessary information to resolve issues.
                                                                                                                                                                                          ","parent_name":"NSObject"},"Extensions/NSObject.html":{"name":"NSObject"},"Extensions/Bundle.html":{"name":"Bundle","abstract":"
                                                                                                                                                                                          Bundle extension to aid in retrieving the SDK resources for getting SDK images.
                                                                                                                                                                                          "},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10AustralianyA2CmF":{"name":"Australian","abstract":"
                                                                                                                                                                                          Australian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9BrazilianyA2CmF":{"name":"Brazilian","abstract":"
                                                                                                                                                                                          Brazilian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO14CanadianFrenchyA2CmF":{"name":"CanadianFrench","abstract":"
                                                                                                                                                                                          CanadianFrench
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7ChineseyA2CmF":{"name":"Chinese","abstract":"
                                                                                                                                                                                          Chinese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO15ChineseHongKongyA2CmF":{"name":"ChineseHongKong","abstract":"
                                                                                                                                                                                          ChineseHongKong
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5CzechyA2CmF":{"name":"Czech","abstract":"
                                                                                                                                                                                          Czech
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6DanishyA2CmF":{"name":"Danish","abstract":"
                                                                                                                                                                                          Danish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO12DutchBelgiumyA2CmF":{"name":"DutchBelgium","abstract":"
                                                                                                                                                                                          DutchBelgium
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO16DutchNetherlandsyA2CmF":{"name":"DutchNetherlands","abstract":"
                                                                                                                                                                                          DutchNetherlands
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7EnglishyA2CmF":{"name":"English","abstract":"
                                                                                                                                                                                          English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7FinnishyA2CmF":{"name":"Finnish","abstract":"
                                                                                                                                                                                          Finnish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6FrenchyA2CmF":{"name":"French","abstract":"
                                                                                                                                                                                          French
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6GermanyA2CmF":{"name":"German","abstract":"
                                                                                                                                                                                          German
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5GreekyA2CmF":{"name":"Greek","abstract":"
                                                                                                                                                                                          Greek
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6HebrewyA2CmF":{"name":"Hebrew","abstract":"
                                                                                                                                                                                          Hebrew
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5HindiyA2CmF":{"name":"Hindi","abstract":"
                                                                                                                                                                                          Hindi
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9HungarianyA2CmF":{"name":"Hungarian","abstract":"
                                                                                                                                                                                          Hungarian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10IndonesianyA2CmF":{"name":"Indonesian","abstract":"
                                                                                                                                                                                          Indonesian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO12IrishEnglishyA2CmF":{"name":"IrishEnglish","abstract":"
                                                                                                                                                                                          IrishEnglish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7ItalianyA2CmF":{"name":"Italian","abstract":"
                                                                                                                                                                                          Italian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO8JapaneseyA2CmF":{"name":"Japanese","abstract":"
                                                                                                                                                                                          Japanese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6KoreanyA2CmF":{"name":"Korean","abstract":"
                                                                                                                                                                                          Korean
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7MexicanyA2CmF":{"name":"Mexican","abstract":"
                                                                                                                                                                                          Mexican
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9NorwegianyA2CmF":{"name":"Norwegian","abstract":"
                                                                                                                                                                                          Norwegian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6PolishyA2CmF":{"name":"Polish","abstract":"
                                                                                                                                                                                          Polish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10PortugueseyA2CmF":{"name":"Portuguese","abstract":"
                                                                                                                                                                                          Portuguese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO8RomanianyA2CmF":{"name":"Romanian","abstract":"
                                                                                                                                                                                          Romanian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7RussianyA2CmF":{"name":"Russian","abstract":"
                                                                                                                                                                                          Russian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO12SaudiArabianyA2CmF":{"name":"SaudiArabian","abstract":"
                                                                                                                                                                                          SaudiArabian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9SlovakianyA2CmF":{"name":"Slovakian","abstract":"
                                                                                                                                                                                          Slovakian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO19SouthAfricanEnglishyA2CmF":{"name":"SouthAfricanEnglish","abstract":"
                                                                                                                                                                                          South African English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7SpanishyA2CmF":{"name":"Spanish","abstract":"
                                                                                                                                                                                          Spanish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7SwedishyA2CmF":{"name":"Swedish","abstract":"
                                                                                                                                                                                          Swedish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9TaiwaneseyA2CmF":{"name":"Taiwanese","abstract":"
                                                                                                                                                                                          Taiwanese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO4ThaiyA2CmF":{"name":"Thai","abstract":"
                                                                                                                                                                                          Thai
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7TurkishyA2CmF":{"name":"Turkish","abstract":"
                                                                                                                                                                                          Turkish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO19UnitedStatesEnglishyA2CmF":{"name":"UnitedStatesEnglish","abstract":"
                                                                                                                                                                                          USA English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10getDetailsAA0C4InfoVyF":{"name":"getDetails()","abstract":"
                                                                                                                                                                                          Will return specific information about the language as an OSSVoiceInfo object.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5titleSSvp":{"name":"title","abstract":"
                                                                                                                                                                                          Provides the Enum key itself as a String
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO11demoMessageSSvp":{"name":"demoMessage","abstract":"
                                                                                                                                                                                          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.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO4flagSo7UIImageCSgvp":{"name":"flag","abstract":"
                                                                                                                                                                                          The flag for the selected language.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO9undefinedyA2CmF":{"name":"undefined","abstract":"
                                                                                                                                                                                          Undefined is the standard recognition type and allows the system to decide which type of task is best.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO9dictationyA2CmF":{"name":"dictation","abstract":"
                                                                                                                                                                                          Use captured speech for text entry purposes.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO6searchyA2CmF":{"name":"search","abstract":"
                                                                                                                                                                                          Use this short speechs that have specific words or terms.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO12confirmationyA2CmF":{"name":"confirmation","abstract":"
                                                                                                                                                                                          Use this for short speechs such as “Yes”, “No”, “Thanks”, etc.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO04taskE0So08SFSpeechcD4HintVvp":{"name":"taskType","abstract":"
                                                                                                                                                                                          Returns a speech recognition hint based on the enum value.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO18noMicrophoneAccessyA2CmF":{"name":"noMicrophoneAccess","abstract":"
                                                                                                                                                                                          No microphone access
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO16invalidUtteranceyA2CmF":{"name":"invalidUtterance","abstract":"
                                                                                                                                                                                          An invalid utterance.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO11invalidTextyA2CmF":{"name":"invalidText","abstract":"
                                                                                                                                                                                          Invalid text - usually an empty string.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO12invalidVoiceyA2CmF":{"name":"invalidVoice","abstract":"
                                                                                                                                                                                          The voice type is invalid.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO20invalidSpeechRequestyA2CmF":{"name":"invalidSpeechRequest","abstract":"
                                                                                                                                                                                          Speech recognition request is invalid.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO18invalidAudioEngineyA2CmF":{"name":"invalidAudioEngine","abstract":"
                                                                                                                                                                                          The audio engine is invalid.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO20recogniserUnavailbleyA2CmF":{"name":"recogniserUnavailble","abstract":"
                                                                                                                                                                                          Voice recognition is unavailable.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO12errorMessageSSvp":{"name":"errorMessage","abstract":"
                                                                                                                                                                                          The OSSSpeechKit error message string.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO012errorRequestD0SSvp":{"name":"errorRequestType","abstract":"
                                                                                                                                                                                          The highlevel type of error that occured.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO5errors0C0_pSgvp":{"name":"error","abstract":"
                                                                                                                                                                                          An error that is used to capture details of the error event.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO13notDeterminedyA2CmF":{"name":"notDetermined","abstract":"
                                                                                                                                                                                          The app’s authorization status has not yet been determined.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO6deniedyA2CmF":{"name":"denied","abstract":"
                                                                                                                                                                                          The user denied your app’s request to perform speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO10restrictedyA2CmF":{"name":"restricted","abstract":"
                                                                                                                                                                                          The device prevents your app from performing speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO10authorizedyA2CmF":{"name":"authorized","abstract":"
                                                                                                                                                                                          The user granted your app’s request to perform speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO7messageSSvp":{"name":"message","abstract":"
                                                                                                                                                                                          A public message that can be displayed to the user.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html":{"name":"OSSSpeechKitAuthorizationStatus","abstract":"
                                                                                                                                                                                          The authorization status of the Microphone and recording, imitating the native SFSpeechRecognizerAuthorizationStatus
                                                                                                                                                                                          "},"Enums/OSSSpeechKitErrorType.html":{"name":"OSSSpeechKitErrorType","abstract":"
                                                                                                                                                                                          All of the possible error types that can be thrown by OSSSpeechKit
                                                                                                                                                                                          "},"Enums/OSSSpeechRecognitionTaskType.html":{"name":"OSSSpeechRecognitionTaskType","abstract":"
                                                                                                                                                                                          The speech recognition task type.
                                                                                                                                                                                          "},"Enums/OSSVoiceEnum.html":{"name":"OSSVoiceEnum","abstract":"
                                                                                                                                                                                          The available system voices.
                                                                                                                                                                                          "},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(py)quality":{"name":"quality","abstract":"
                                                                                                                                                                                          You have access to set the voice quality or use the default which is set to .default
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(py)language":{"name":"language","abstract":"
                                                                                                                                                                                          Language offers a get and set. The default value is United States English.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/s:12OSSSpeechKit8OSSVoiceC9voiceTypeAA0C4EnumOvp":{"name":"voiceType","abstract":"
                                                                                                                                                                                          Returns the current voice type enum to allow for obtining details.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(im)init":{"name":"init()","abstract":"
                                                                                                                                                                                          If this init is used, defaults will be used.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/s:12OSSSpeechKit8OSSVoiceC7quality8languageACSgSo29AVSpeechSynthesisVoiceQualityV_AA0C4EnumOtcfc":{"name":"init(quality:language:)","abstract":"
                                                                                                                                                                                          This init method is required as it sets the voice quality and language in order to speak the text passed in.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(im)initWithCoder:":{"name":"init(coder:)","abstract":"
                                                                                                                                                                                          Required: Do not recommend using.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(py)speechString":{"name":"speechString","abstract":"
                                                                                                                                                                                          The speechString can be a constant value or changed as frequently as you wish.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(py)attributedSpeechString":{"name":"attributedSpeechString","abstract":"
                                                                                                                                                                                          The attributedSpeechString can be a constant value or changed as frequently as you wish.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)init":{"name":"init()","abstract":"
                                                                                                                                                                                          Undocumented
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)initWithString:":{"name":"init(string:)","abstract":"
                                                                                                                                                                                          Init method which will set the speechString value.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)initWithAttributedString:":{"name":"init(attributedString:)","abstract":"
                                                                                                                                                                                          Init method which will set the attributedSpeechString value.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)initWithCoder:":{"name":"init(coder:)","abstract":"
                                                                                                                                                                                          Required. Do not recommend using.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSSpeechUtility.html#/s:12OSSSpeechKit0A7UtilityC16stringsTableNameSSvp":{"name":"stringsTableName","abstract":"
                                                                                                                                                                                          Change this property to your strings table name if you wish to override the SDK strings values in your app.
                                                                                                                                                                                          ","parent_name":"OSSSpeechUtility"},"Classes/OSSSpeechUtility.html#/s:12OSSSpeechKit0A7UtilityC9getString16forLocalizedName12defaultValueS2S_SStF":{"name":"getString(forLocalizedName:defaultValue:)","abstract":"
                                                                                                                                                                                          A helper method that enables all Localized strings to be overridden by the main application.
                                                                                                                                                                                          ","parent_name":"OSSSpeechUtility"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C8delegateAA0A8Delegate_pSgvp":{"name":"delegate","abstract":"
                                                                                                                                                                                          Delegate allows for the recieving of spoken events.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C5voiceAA8OSSVoiceCSgvp":{"name":"voice","abstract":"
                                                                                                                                                                                          An object that allows overriding the default AVVoice options.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C28shouldUseOnDeviceRecognitionSbvp":{"name":"shouldUseOnDeviceRecognition","abstract":"
                                                                                                                                                                                          Speech recognition variable to determine if recognition should use on device capabilities if available
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C19recognitionTaskTypeAA0a11RecognitiondE0Ovp":{"name":"recognitionTaskType","abstract":"
                                                                                                                                                                                          The task type by default is undefined.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C9utteranceAA12OSSUtteranceCSgvp":{"name":"utterance","abstract":"
                                                                                                                                                                                          The object used to enable translation of strings to synthsized voice.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C12audioSessionSo07AVAudioD0Cvp":{"name":"audioSession","abstract":"
                                                                                                                                                                                          Audio Session can be overriden should you choose to.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C3srpSo18SFSpeechRecognizerCmvp":{"name":"srp","abstract":"
                                                                                                                                                                                          This property handles permission authorization.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C6sharedACvpZ":{"name":"shared","abstract":"
                                                                                                                                                                                          A singleton object to ensure conformity accross the application it is used in.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C9speakTextyySSSgF":{"name":"speakText(_:)","abstract":"
                                                                                                                                                                                          Pass in a string to speak.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C19speakAttributedText010attributedE0ySo18NSAttributedStringC_tF":{"name":"speakAttributedText(attributedText:)","abstract":"
                                                                                                                                                                                          Pass in an attributed string to speak.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C11recordVoice20requestMicPermissionySb_tF":{"name":"recordVoice(requestMicPermission:)","abstract":"
                                                                                                                                                                                          Record and recognise speech
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C17endVoiceRecordingyyF":{"name":"endVoiceRecording()","abstract":"
                                                                                                                                                                                          End recording of speech session if one exists.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C11engineSetupySbSo13AVAudioEngineCF":{"name":"engineSetup(_:)","abstract":"
                                                                                                                                                                                          Undocumented
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTask:didFinishSuccessfully:":{"name":"speechRecognitionTask(_:didFinishSuccessfully:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognitionTaskDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTask:didHypothesizeTranscription:":{"name":"speechRecognitionTask(_:didHypothesizeTranscription:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognitionTaskDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTask:didFinishRecognition:":{"name":"speechRecognitionTask(_:didFinishRecognition:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognitionTaskDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionDidDetectSpeech:":{"name":"speechRecognitionDidDetectSpeech(_:)","abstract":"
                                                                                                                                                                                          Undocumented
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTaskFinishedReadingAudio:":{"name":"speechRecognitionTaskFinishedReadingAudio(_:)","abstract":"
                                                                                                                                                                                          Undocumented
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognizer:availabilityDidChange:":{"name":"speechRecognizer(_:availabilityDidChange:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognizerDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html":{"name":"OSSSpeech","abstract":"
                                                                                                                                                                                          Speech is the primary interface. To use, set the voice and then call .speak(string: "your string")
                                                                                                                                                                                          "},"Classes/OSSSpeechUtility.html":{"name":"OSSSpeechUtility","abstract":"
                                                                                                                                                                                          Undocumented
                                                                                                                                                                                          "},"Classes/OSSUtterance.html":{"name":"OSSUtterance","abstract":"
                                                                                                                                                                                          OSSUtterance is a wrapper of the AVSpeechUtterance class.
                                                                                                                                                                                          "},"Classes/OSSVoice.html":{"name":"OSSVoice","abstract":"
                                                                                                                                                                                          OSSVoice overides some of the properties provided to enable setting as well as getting.
                                                                                                                                                                                          "},"Classes.html":{"name":"Classes","abstract":"
                                                                                                                                                                                          The following classes are available globally.
                                                                                                                                                                                          "},"Enums.html":{"name":"Enumerations","abstract":"
                                                                                                                                                                                          The following enumerations are available globally.
                                                                                                                                                                                          "},"Extensions.html":{"name":"Extensions","abstract":"
                                                                                                                                                                                          The following extensions are available globally.
                                                                                                                                                                                          "},"Protocols.html":{"name":"Protocols","abstract":"
                                                                                                                                                                                          The following protocols are available globally.
                                                                                                                                                                                          "},"Structs.html":{"name":"Structures","abstract":"
                                                                                                                                                                                          The following structures are available globally.
                                                                                                                                                                                          "}}
\ No newline at end of file
+{"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV4nameSSSgvp":{"name":"name","abstract":"
                                                                                                                                                                                          The name of the voice; All AVSpeechSynthesisVoice instances have a persons name.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV8languageSSSgvp":{"name":"language","abstract":"
                                                                                                                                                                                          The name of the language being used.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV12languageCodeSSSgvp":{"name":"languageCode","abstract":"
                                                                                                                                                                                          The language code is what is internationally used in Locale settings.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV10identifierypSgvp":{"name":"identifier","abstract":"
                                                                                                                                                                                          Identifier is a unique bundle URL provided by Apple for each voice.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV15voiceIdentifierSSSgvp":{"name":"voiceIdentifier","abstract":"
                                                                                                                                                                                          Typed identifier for the resolved AVSpeechSynthesisVoice.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSUtteranceConfiguration.html#/s:12OSSSpeechKit25OSSUtteranceConfigurationV4rateSfvp":{"name":"rate","abstract":"
                                                                                                                                                                                          Speech rate to apply to the utterance.
                                                                                                                                                                                          ","parent_name":"OSSUtteranceConfiguration"},"Structs/OSSUtteranceConfiguration.html#/s:12OSSSpeechKit25OSSUtteranceConfigurationV15pitchMultiplierSfvp":{"name":"pitchMultiplier","abstract":"
                                                                                                                                                                                          Pitch multiplier to apply to the utterance.
                                                                                                                                                                                          ","parent_name":"OSSUtteranceConfiguration"},"Structs/OSSUtteranceConfiguration.html#/s:12OSSSpeechKit25OSSUtteranceConfigurationV6volumeSfvp":{"name":"volume","abstract":"
                                                                                                                                                                                          Playback volume to apply to the utterance.
                                                                                                                                                                                          ","parent_name":"OSSUtteranceConfiguration"},"Structs/OSSUtteranceConfiguration.html#/s:12OSSSpeechKit25OSSUtteranceConfigurationV17preUtteranceDelaySdvp":{"name":"preUtteranceDelay","abstract":"
                                                                                                                                                                                          Delay before the utterance begins speaking.
                                                                                                                                                                                          ","parent_name":"OSSUtteranceConfiguration"},"Structs/OSSUtteranceConfiguration.html#/s:12OSSSpeechKit25OSSUtteranceConfigurationV18postUtteranceDelaySdvp":{"name":"postUtteranceDelay","abstract":"
                                                                                                                                                                                          Delay after the utterance finishes speaking.
                                                                                                                                                                                          ","parent_name":"OSSUtteranceConfiguration"},"Structs/OSSUtteranceConfiguration.html#/s:12OSSSpeechKit25OSSUtteranceConfigurationV4rate15pitchMultiplier6volume17preUtteranceDelay04postjK0ACSf_S2fS2dtcfc":{"name":"init(rate:pitchMultiplier:volume:preUtteranceDelay:postUtteranceDelay:)","abstract":"
                                                                                                                                                                                          Creates speech synthesis parameters for an utterance.
                                                                                                                                                                                          ","parent_name":"OSSUtteranceConfiguration"},"Structs/OSSVoiceConfiguration.html#/s:12OSSSpeechKit21OSSVoiceConfigurationV8languageAA11OSSLanguageVvp":{"name":"language","abstract":"
                                                                                                                                                                                          Language or regional variant used to search installed voices.
                                                                                                                                                                                          ","parent_name":"OSSVoiceConfiguration"},"Structs/OSSVoiceConfiguration.html#/s:12OSSSpeechKit21OSSVoiceConfigurationV19preferredIdentifierSSSgvp":{"name":"preferredIdentifier","abstract":"
                                                                                                                                                                                          Specific AVFoundation voice identifier to prefer when available.
                                                                                                                                                                                          ","parent_name":"OSSVoiceConfiguration"},"Structs/OSSVoiceConfiguration.html#/s:12OSSSpeechKit21OSSVoiceConfigurationV16preferredQualitySo022AVSpeechSynthesisVoiceF0VSgvp":{"name":"preferredQuality","abstract":"
                                                                                                                                                                                          Preferred voice quality to use when multiple voices match the language.
                                                                                                                                                                                          ","parent_name":"OSSVoiceConfiguration"},"Structs/OSSVoiceConfiguration.html#/s:12OSSSpeechKit21OSSVoiceConfigurationV8language19preferredIdentifier0F7QualityAcA11OSSLanguageV_SSSgSo022AVSpeechSynthesisVoiceH0VSgtcfc":{"name":"init(language:preferredIdentifier:preferredQuality:)","abstract":"
                                                                                                                                                                                          Creates a voice selection request.
                                                                                                                                                                                          ","parent_name":"OSSVoiceConfiguration"},"Structs/OSSVoiceConfiguration.html#/s:12OSSSpeechKit21OSSVoiceConfigurationV7resolveSo22AVSpeechSynthesisVoiceCSgyF":{"name":"resolve()","abstract":"
                                                                                                                                                                                          Resolves the best currently available system voice without relying on","parent_name":"OSSVoiceConfiguration"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV2idSSvp":{"name":"id","abstract":"
                                                                                                                                                                                          Stable identifier used by OSSSpeechKit to refer to this catalog entry.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV4nameSSvp":{"name":"name","abstract":"
                                                                                                                                                                                          Human-readable language or regional variant name for display.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV6locale10Foundation6LocaleVvp":{"name":"locale","abstract":"
                                                                                                                                                                                          Foundation locale that describes the language and region.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV10regionCodeSSSgvp":{"name":"regionCode","abstract":"
                                                                                                                                                                                          Region override used when the locale alone cannot distinguish a variant.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV25preferredVoiceIdentifiersSaySSGvp":{"name":"preferredVoiceIdentifiers","abstract":"
                                                                                                                                                                                          Voice identifiers that should be preferred when matching installed voices.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV2id4name16localeIdentifier10regionCode25preferredVoiceIdentifiersACSS_S3SSgSaySSGtcfc":{"name":"init(id:name:localeIdentifier:regionCode:preferredVoiceIdentifiers:)","abstract":"
                                                                                                                                                                                          Creates language metadata for the OSSSpeechKit catalog.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV16localeIdentifierSSvp":{"name":"localeIdentifier","abstract":"
                                                                                                                                                                                          The canonicalized BCP 47 identifier used for runtime capability checks.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV24availableSynthesisVoicesSaySo08AVSpeechE5VoiceCGvp":{"name":"availableSynthesisVoices","abstract":"
                                                                                                                                                                                          Voices currently installed or exposed by the operating system.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV19supportsRecognitionSbvp":{"name":"supportsRecognition","abstract":"
                                                                                                                                                                                          Whether the legacy Speech recognizer reports this locale as supported.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV26supportedRecognitionLocale12equivalentTo10Foundation0F0VSgAH_tFZ":{"name":"supportedRecognitionLocale(equivalentTo:)","abstract":"
                                                                                                                                                                                          Returns the exact supported recognition locale, or a same-language,","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV9flagEmojiSSvp":{"name":"flagEmoji","abstract":"
                                                                                                                                                                                          A Unicode flag suitable for labels, SwiftUI Text, and accessibility.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV17renderedFlagImage9pointSize5scaleSo7UIImageC14CoreFoundation7CGFloatV_AKtF":{"name":"renderedFlagImage(pointSize:scale:)","abstract":"
                                                                                                                                                                                          Renders flagEmoji to an image for UIKit clients that require one.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV7catalogSayACGvpZ":{"name":"catalog","abstract":"
                                                                                                                                                                                          Curated languages and regional variants described by Apple’s current","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html":{"name":"OSSLanguage","abstract":"
                                                                                                                                                                                          Display metadata for a language or regional voice supported by Apple platforms.
                                                                                                                                                                                          "},"Structs/OSSVoiceConfiguration.html":{"name":"OSSVoiceConfiguration","abstract":"
                                                                                                                                                                                          Selects an actual voice exposed by AVFoundation.
                                                                                                                                                                                          "},"Structs/OSSUtteranceConfiguration.html":{"name":"OSSUtteranceConfiguration","abstract":"
                                                                                                                                                                                          Value-style speech parameters used to construct a fresh AVFoundation"},"Structs/OSSVoiceInfo.html":{"name":"OSSVoiceInfo","abstract":"
                                                                                                                                                                                          Information about a resolved system voice.
                                                                                                                                                                                          "},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP18didFinishListening8withTextySS_tF":{"name":"didFinishListening(withText:)","abstract":"
                                                                                                                                                                                          When the microphone has finished accepting audio, this delegate will be called with the final best text output.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP25authorizationToMicrophone18withAuthenticationyAA0aB19AuthorizationStatusO_tF":{"name":"authorizationToMicrophone(withAuthentication:)","abstract":"
                                                                                                                                                                                          Handle returning authentication status to user - primary use is for non-authorized state.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP32didFailToCommenceSpeechRecordingyyF":{"name":"didFailToCommenceSpeechRecording()","abstract":"
                                                                                                                                                                                          If the speech recogniser and request fail to set up, this method will be called.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP22didCompleteTranslation8withTextySS_tF":{"name":"didCompleteTranslation(withText:)","abstract":"
                                                                                                                                                                                          Method for real time recpetion of translated text.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP23didFailToProcessRequest9withErrorys0J0_pSg_tF":{"name":"didFailToProcessRequest(withError:)","abstract":"
                                                                                                                                                                                          Error handling function.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html":{"name":"OSSSpeechDelegate","abstract":"
                                                                                                                                                                                          Delegate to handle events such as failed authentication for microphone among many more.
                                                                                                                                                                                          "},"Extensions/NSObject.html#/s:So8NSObjectC12OSSSpeechKitE8debugLog6object12functionName04fileH010lineNumber7messageyyp_S2SSiSStF":{"name":"debugLog(object:functionName:fileName:lineNumber:message:)","abstract":"
                                                                                                                                                                                          Method outputs a debug statement containing necessary information to resolve issues.
                                                                                                                                                                                          ","parent_name":"NSObject"},"Extensions/NSObject.html":{"name":"NSObject"},"Enums/OSSSpeechRecognitionEvent.html#/s:12OSSSpeechKit0A16RecognitionEventO7partialyACSScACmF":{"name":"partial(_:)","abstract":"
                                                                                                                                                                                          Interim transcription text emitted before recognition completes.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionEvent"},"Enums/OSSSpeechRecognitionEvent.html#/s:12OSSSpeechKit0A16RecognitionEventO9completedyACSScACmF":{"name":"completed(_:)","abstract":"
                                                                                                                                                                                          Final transcription text emitted when recognition completes.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionEvent"},"Enums/OSSSpeechRecognitionEvent.html#/s:12OSSSpeechKit0A16RecognitionEventO19availabilityChangedyACSbcACmF":{"name":"availabilityChanged(_:)","abstract":"
                                                                                                                                                                                          Availability updates reported by the underlying speech recognizer.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionEvent"},"Enums/OSSSpeechRecognitionEvent.html#/s:12OSSSpeechKit0A16RecognitionEventO9cancelledyA2CmF":{"name":"cancelled","abstract":"
                                                                                                                                                                                          Recognition was cancelled before producing a final result.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionEvent"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO9emptyTextyA2CmF":{"name":"emptyText","abstract":"
                                                                                                                                                                                          The provided speech text was empty or only whitespace.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO16voiceUnavailableyACSS_tcACmF":{"name":"voiceUnavailable(localeIdentifier:)","abstract":"
                                                                                                                                                                                          No installed speech synthesis voice matched the requested locale.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO25speechAuthorizationDeniedyA2CmF":{"name":"speechAuthorizationDenied","abstract":"
                                                                                                                                                                                          Speech recognition authorization was denied or unavailable.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO29microphoneAuthorizationDeniedyA2CmF":{"name":"microphoneAuthorizationDenied","abstract":"
                                                                                                                                                                                          Microphone recording authorization was denied or unavailable.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO28recognitionLocaleUnsupportedyACSScACmF":{"name":"recognitionLocaleUnsupported(_:)","abstract":"
                                                                                                                                                                                          Speech recognition does not support the requested locale on this device.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO21recognizerUnavailableyA2CmF":{"name":"recognizerUnavailable","abstract":"
                                                                                                                                                                                          The speech recognizer exists but is not currently available.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO18audioEngineFailureyACs0C0_pSg_tcACmF":{"name":"audioEngineFailure(underlying:)","abstract":"
                                                                                                                                                                                          AVFoundation could not configure or start the audio engine/session.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO19operationInProgressyA2CmF":{"name":"operationInProgress","abstract":"
                                                                                                                                                                                          A speech synthesis or recognition operation is already active.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp":{"name":"errorDescription","parent_name":"OSSSpeechError"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO9undefinedyA2CmF":{"name":"undefined","abstract":"
                                                                                                                                                                                          Undefined is the standard recognition type and allows the system to decide which type of task is best.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO9dictationyA2CmF":{"name":"dictation","abstract":"
                                                                                                                                                                                          Use captured speech for text entry purposes.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO6searchyA2CmF":{"name":"search","abstract":"
                                                                                                                                                                                          Use this short speechs that have specific words or terms.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO12confirmationyA2CmF":{"name":"confirmation","abstract":"
                                                                                                                                                                                          Use this for short speechs such as “Yes”, “No”, “Thanks”, etc.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO04taskE0So08SFSpeechcD4HintVvp":{"name":"taskType","abstract":"
                                                                                                                                                                                          Returns a speech recognition hint based on the enum value.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO18noMicrophoneAccessyA2CmF":{"name":"noMicrophoneAccess","abstract":"
                                                                                                                                                                                          No microphone access
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO16invalidUtteranceyA2CmF":{"name":"invalidUtterance","abstract":"
                                                                                                                                                                                          An invalid utterance.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO11invalidTextyA2CmF":{"name":"invalidText","abstract":"
                                                                                                                                                                                          Invalid text - usually an empty string.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO12invalidVoiceyA2CmF":{"name":"invalidVoice","abstract":"
                                                                                                                                                                                          The voice type is invalid.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO20invalidSpeechRequestyA2CmF":{"name":"invalidSpeechRequest","abstract":"
                                                                                                                                                                                          Speech recognition request is invalid.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO18invalidAudioEngineyA2CmF":{"name":"invalidAudioEngine","abstract":"
                                                                                                                                                                                          The audio engine is invalid.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO20recogniserUnavailbleyA2CmF":{"name":"recogniserUnavailble","abstract":"
                                                                                                                                                                                          Voice recognition is unavailable.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO12errorMessageSSvp":{"name":"errorMessage","abstract":"
                                                                                                                                                                                          The OSSSpeechKit error message string.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO012errorRequestD0SSvp":{"name":"errorRequestType","abstract":"
                                                                                                                                                                                          The highlevel type of error that occured.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO5errors0C0_pSgvp":{"name":"error","abstract":"
                                                                                                                                                                                          An error that is used to capture details of the error event.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO13notDeterminedyA2CmF":{"name":"notDetermined","abstract":"
                                                                                                                                                                                          The app’s authorization status has not yet been determined.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO6deniedyA2CmF":{"name":"denied","abstract":"
                                                                                                                                                                                          The user denied your app’s request to perform speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO10restrictedyA2CmF":{"name":"restricted","abstract":"
                                                                                                                                                                                          The device prevents your app from performing speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO10authorizedyA2CmF":{"name":"authorized","abstract":"
                                                                                                                                                                                          The user granted your app’s request to perform speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO7messageSSvp":{"name":"message","abstract":"
                                                                                                                                                                                          A public message that can be displayed to the user.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10AustralianyA2CmF":{"name":"Australian","abstract":"
                                                                                                                                                                                          Australian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9BrazilianyA2CmF":{"name":"Brazilian","abstract":"
                                                                                                                                                                                          Brazilian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9BulgarianyA2CmF":{"name":"Bulgarian","abstract":"
                                                                                                                                                                                          Bulgarian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO14CanadianFrenchyA2CmF":{"name":"CanadianFrench","abstract":"
                                                                                                                                                                                          CanadianFrench
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7ChineseyA2CmF":{"name":"Chinese","abstract":"
                                                                                                                                                                                          Chinese Traditional
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO17ChineseSimplifiedyA2CmF":{"name":"ChineseSimplified","abstract":"
                                                                                                                                                                                          Chinese Simplified
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO15ChineseHongKongyA2CmF":{"name":"ChineseHongKong","abstract":"
                                                                                                                                                                                          ChineseHongKong
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO8CroatianyA2CmF":{"name":"Croatian","abstract":"
                                                                                                                                                                                          Croatian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5CzechyA2CmF":{"name":"Czech","abstract":"
                                                                                                                                                                                          Czech
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6DanishyA2CmF":{"name":"Danish","abstract":"
                                                                                                                                                                                          Danish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO12DutchBelgiumyA2CmF":{"name":"DutchBelgium","abstract":"
                                                                                                                                                                                          DutchBelgium
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO16DutchNetherlandsyA2CmF":{"name":"DutchNetherlands","abstract":"
                                                                                                                                                                                          DutchNetherlands
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7EnglishyA2CmF":{"name":"English","abstract":"
                                                                                                                                                                                          English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7FinnishyA2CmF":{"name":"Finnish","abstract":"
                                                                                                                                                                                          Finnish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6FrenchyA2CmF":{"name":"French","abstract":"
                                                                                                                                                                                          French
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6GermanyA2CmF":{"name":"German","abstract":"
                                                                                                                                                                                          German
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5GreekyA2CmF":{"name":"Greek","abstract":"
                                                                                                                                                                                          Greek
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6HebrewyA2CmF":{"name":"Hebrew","abstract":"
                                                                                                                                                                                          Hebrew
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5HindiyA2CmF":{"name":"Hindi","abstract":"
                                                                                                                                                                                          Hindi
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9HungarianyA2CmF":{"name":"Hungarian","abstract":"
                                                                                                                                                                                          Hungarian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO13IndianEnglishyA2CmF":{"name":"IndianEnglish","abstract":"
                                                                                                                                                                                          Indian English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10IndonesianyA2CmF":{"name":"Indonesian","abstract":"
                                                                                                                                                                                          Indonesian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO12IrishEnglishyA2CmF":{"name":"IrishEnglish","abstract":"
                                                                                                                                                                                          IrishEnglish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7ItalianyA2CmF":{"name":"Italian","abstract":"
                                                                                                                                                                                          Italian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO8JapaneseyA2CmF":{"name":"Japanese","abstract":"
                                                                                                                                                                                          Japanese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6KoreanyA2CmF":{"name":"Korean","abstract":"
                                                                                                                                                                                          Korean
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5MalayyA2CmF":{"name":"Malay","abstract":"
                                                                                                                                                                                          Malaysian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7MexicanyA2CmF":{"name":"Mexican","abstract":"
                                                                                                                                                                                          Mexican
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9NorwegianyA2CmF":{"name":"Norwegian","abstract":"
                                                                                                                                                                                          Norwegian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO15NorwegianBokmalyA2CmF":{"name":"NorwegianBokmal","abstract":"
                                                                                                                                                                                          Norwegian Bokmal
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6PolishyA2CmF":{"name":"Polish","abstract":"
                                                                                                                                                                                          Polish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10PortugueseyA2CmF":{"name":"Portuguese","abstract":"
                                                                                                                                                                                          Portuguese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO8RomanianyA2CmF":{"name":"Romanian","abstract":"
                                                                                                                                                                                          Romanian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7RussianyA2CmF":{"name":"Russian","abstract":"
                                                                                                                                                                                          Russian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO12SaudiArabianyA2CmF":{"name":"SaudiArabian","abstract":"
                                                                                                                                                                                          SaudiArabian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9SlovakianyA2CmF":{"name":"Slovakian","abstract":"
                                                                                                                                                                                          Slovakian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO19SouthAfricanEnglishyA2CmF":{"name":"SouthAfricanEnglish","abstract":"
                                                                                                                                                                                          South African English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7SpanishyA2CmF":{"name":"Spanish","abstract":"
                                                                                                                                                                                          Spanish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO14SpanishCatalanyA2CmF":{"name":"SpanishCatalan","abstract":"
                                                                                                                                                                                          Catalan
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7SwedishyA2CmF":{"name":"Swedish","abstract":"
                                                                                                                                                                                          Swedish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9TaiwaneseyA2CmF":{"name":"Taiwanese","abstract":"
                                                                                                                                                                                          Taiwanese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO4ThaiyA2CmF":{"name":"Thai","abstract":"
                                                                                                                                                                                          Thai
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7TurkishyA2CmF":{"name":"Turkish","abstract":"
                                                                                                                                                                                          Turkish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO8UkranianyA2CmF":{"name":"Ukranian","abstract":"
                                                                                                                                                                                          Ukranian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO19UnitedStatesEnglishyA2CmF":{"name":"UnitedStatesEnglish","abstract":"
                                                                                                                                                                                          USA English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10VietnameseyA2CmF":{"name":"Vietnamese","abstract":"
                                                                                                                                                                                          Vietnamese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO11ArabicWorldyA2CmF":{"name":"ArabicWorld","abstract":"
                                                                                                                                                                                          Arabic World
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10getDetailsAA0C4InfoVyF":{"name":"getDetails()","abstract":"
                                                                                                                                                                                          Will return specific information about the language as an OSSVoiceInfo object.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5titleSSvp":{"name":"title","abstract":"
                                                                                                                                                                                          Provides the Enum key itself as a String
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO11demoMessageSSvp":{"name":"demoMessage","abstract":"
                                                                                                                                                                                          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.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO4flagSo7UIImageCSgvp":{"name":"flag","abstract":"
                                                                                                                                                                                          The legacy image flag for the selected language.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO25canonicalLocaleIdentifierSSvp":{"name":"canonicalLocaleIdentifier","abstract":"
                                                                                                                                                                                          The canonical locale used by the modern API.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO16languageMetadataAA11OSSLanguageVvp":{"name":"languageMetadata","abstract":"
                                                                                                                                                                                          Modern metadata corresponding to this legacy case.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9flagEmojiSSvp":{"name":"flagEmoji","abstract":"
                                                                                                                                                                                          Preferred Unicode replacement for the legacy image property.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO17renderedFlagImage9pointSize5scaleSo7UIImageC14CoreFoundation7CGFloatV_AKtF":{"name":"renderedFlagImage(pointSize:scale:)","abstract":"
                                                                                                                                                                                          Renders flagEmoji for UIKit clients.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html":{"name":"OSSVoiceEnum","abstract":"
                                                                                                                                                                                          The available system voices.
                                                                                                                                                                                          "},"Enums/OSSSpeechKitAuthorizationStatus.html":{"name":"OSSSpeechKitAuthorizationStatus","abstract":"
                                                                                                                                                                                          The authorization status of the Microphone and recording, imitating the native SFSpeechRecognizerAuthorizationStatus
                                                                                                                                                                                          "},"Enums/OSSSpeechKitErrorType.html":{"name":"OSSSpeechKitErrorType","abstract":"
                                                                                                                                                                                          All of the possible error types that can be thrown by OSSSpeechKit
                                                                                                                                                                                          "},"Enums/OSSSpeechRecognitionTaskType.html":{"name":"OSSSpeechRecognitionTaskType","abstract":"
                                                                                                                                                                                          The speech recognition task type.
                                                                                                                                                                                          "},"Enums/OSSSpeechError.html":{"name":"OSSSpeechError","abstract":"
                                                                                                                                                                                          Typed failures emitted by the modern OSSSpeechKit API.
                                                                                                                                                                                          "},"Enums/OSSSpeechRecognitionEvent.html":{"name":"OSSSpeechRecognitionEvent","abstract":"
                                                                                                                                                                                          Events from a live recognition session.
                                                                                                                                                                                          "},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(py)quality":{"name":"quality","abstract":"
                                                                                                                                                                                          You have access to set the voice quality or use the default which is set to .default
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(py)language":{"name":"language","abstract":"
                                                                                                                                                                                          Language offers a get and set. The default value is United States English.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/s:12OSSSpeechKit8OSSVoiceC9voiceTypeAA0C4EnumOvp":{"name":"voiceType","abstract":"
                                                                                                                                                                                          Returns the current voice type enum to allow for obtining details.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(im)init":{"name":"init()","abstract":"
                                                                                                                                                                                          If this init is used, defaults will be used.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/s:12OSSSpeechKit8OSSVoiceC7quality8languageACSgSo29AVSpeechSynthesisVoiceQualityV_AA0C4EnumOtcfc":{"name":"init(quality:language:)","abstract":"
                                                                                                                                                                                          This init method is required as it sets the voice quality and language in order to speak the text passed in.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(im)initWithCoder:":{"name":"init(coder:)","abstract":"
                                                                                                                                                                                          Required: Do not recommend using.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(py)speechString":{"name":"speechString","abstract":"
                                                                                                                                                                                          The speechString can be a constant value or changed as frequently as you wish.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(py)attributedSpeechString":{"name":"attributedSpeechString","abstract":"
                                                                                                                                                                                          The attributedSpeechString can be a constant value or changed as frequently as you wish.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)init":{"name":"init()","abstract":"
                                                                                                                                                                                          Creates an error placeholder utterance.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)initWithString:":{"name":"init(string:)","abstract":"
                                                                                                                                                                                          Init method which will set the speechString value.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)initWithAttributedString:":{"name":"init(attributedString:)","abstract":"
                                                                                                                                                                                          Init method which will set the attributedSpeechString value.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)initWithCoder:":{"name":"init(coder:)","abstract":"
                                                                                                                                                                                          Required. Do not recommend using.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSSpeechUtility.html#/s:12OSSSpeechKit0A7UtilityC16stringsTableNameSSvp":{"name":"stringsTableName","abstract":"
                                                                                                                                                                                          Change this property to your strings table name if you wish to override the SDK strings values in your app.
                                                                                                                                                                                          ","parent_name":"OSSSpeechUtility"},"Classes/OSSSpeechUtility.html#/s:12OSSSpeechKit0A7UtilityC9getString16forLocalizedName12defaultValueS2S_SStF":{"name":"getString(forLocalizedName:defaultValue:)","abstract":"
                                                                                                                                                                                          A helper method that enables all Localized strings to be overridden by the main application.
                                                                                                                                                                                          ","parent_name":"OSSSpeechUtility"},"Classes/OSSSpeechEngine/State.html#/s:12OSSSpeechKit0A6EngineC5StateO4idleyA2EmF":{"name":"idle","abstract":"
                                                                                                                                                                                          The engine is not speaking or listening.
                                                                                                                                                                                          ","parent_name":"State"},"Classes/OSSSpeechEngine/State.html#/s:12OSSSpeechKit0A6EngineC5StateO8speakingyA2EmF":{"name":"speaking","abstract":"
                                                                                                                                                                                          The engine is currently synthesizing speech.
                                                                                                                                                                                          ","parent_name":"State"},"Classes/OSSSpeechEngine/State.html#/s:12OSSSpeechKit0A6EngineC5StateO9listeningyA2EmF":{"name":"listening","abstract":"
                                                                                                                                                                                          The engine is currently recording and recognizing speech.
                                                                                                                                                                                          ","parent_name":"State"},"Classes/OSSSpeechEngine/State.html":{"name":"State","abstract":"
                                                                                                                                                                                          Current high-level activity of the speech engine.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC5stateAC5StateOvp":{"name":"state","abstract":"
                                                                                                                                                                                          Current high-level activity of the engine.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC23usesOnDeviceRecognitionSbvp":{"name":"usesOnDeviceRecognition","abstract":"
                                                                                                                                                                                          Whether recognition should require on-device processing when supported.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC19recognitionTaskHintSo019SFSpeechRecognitioneF0Vvp":{"name":"recognitionTaskHint","abstract":"
                                                                                                                                                                                          Task hint passed to the underlying speech recognizer.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/c:@M@OSSSpeechKit@objc(cs)OSSSpeechEngine(im)init":{"name":"init()","abstract":"
                                                                                                                                                                                          Creates a speech engine with its own synthesizer, audio engine, and audio session.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC27supportedRecognitionLocalesShy10Foundation6LocaleVGvpZ":{"name":"supportedRecognitionLocales","abstract":"
                                                                                                                                                                                          Locales that the platform reports as available for speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC26requestSpeechAuthorizationAA0abF6StatusOyYaF":{"name":"requestSpeechAuthorization()","abstract":"
                                                                                                                                                                                          Requests speech recognition authorization and maps the native status.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC30requestMicrophoneAuthorizationSbyYaF":{"name":"requestMicrophoneAuthorization()","abstract":"
                                                                                                                                                                                          Requests microphone recording authorization.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC5speak_5voice13configurationySS_AA21OSSVoiceConfigurationVAA012OSSUtteranceH0VtYaKF":{"name":"speak(_:voice:configuration:)","abstract":"
                                                                                                                                                                                          Speaks plain text using a resolved AVFoundation voice.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC5speak_5voice13configurationySo18NSAttributedStringC_AA21OSSVoiceConfigurationVAA012OSSUtteranceJ0VtYaKF":{"name":"speak(_:voice:configuration:)","abstract":"
                                                                                                                                                                                          Speaks attributed text using a resolved AVFoundation voice.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC13pauseSpeakingyyF":{"name":"pauseSpeaking()","abstract":"
                                                                                                                                                                                          Pauses the current utterance immediately when the engine is speaking.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC16continueSpeakingyyF":{"name":"continueSpeaking()","abstract":"
                                                                                                                                                                                          Resumes a paused utterance.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC12stopSpeakingyyF":{"name":"stopSpeaking()","abstract":"
                                                                                                                                                                                          Stops the current utterance and finishes the synthesis operation.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC17recognitionEvents6locale20requestAuthorizationScsyAA0A16RecognitionEventOs5Error_pG10Foundation6LocaleV_SbtYaKF":{"name":"recognitionEvents(locale:requestAuthorization:)","abstract":"
                                                                                                                                                                                          Starts recognition and returns a stream that owns the recording session.","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC17cancelRecognitionyyF":{"name":"cancelRecognition()","abstract":"
                                                                                                                                                                                          Cancels the active recognition session and tears down audio recording.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeechEngine(im)speechSynthesizer:didFinishSpeechUtterance:":{"name":"speechSynthesizer(_:didFinish:)","abstract":"
                                                                                                                                                                                          Completes the awaiting synthesis operation when AVFoundation finishes speaking.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeechEngine(im)speechSynthesizer:didCancelSpeechUtterance:":{"name":"speechSynthesizer(_:didCancel:)","abstract":"
                                                                                                                                                                                          Completes the awaiting synthesis operation with cancellation when speech is cancelled.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeechEngine(im)speechRecognizer:availabilityDidChange:":{"name":"speechRecognizer(_:availabilityDidChange:)","abstract":"
                                                                                                                                                                                          Emits recognizer availability changes to the active recognition stream.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C8delegateAA0A8Delegate_pSgvp":{"name":"delegate","abstract":"
                                                                                                                                                                                          Delegate allows for the recieving of spoken events.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C5voiceAA8OSSVoiceCSgvp":{"name":"voice","abstract":"
                                                                                                                                                                                          An object that allows overriding the default AVVoice options.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C28shouldUseOnDeviceRecognitionSbvp":{"name":"shouldUseOnDeviceRecognition","abstract":"
                                                                                                                                                                                          Speech recognition variable to determine if recognition should use on device capabilities if available
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C19recognitionTaskTypeAA0a11RecognitiondE0Ovp":{"name":"recognitionTaskType","abstract":"
                                                                                                                                                                                          The task type by default is undefined.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C9utteranceAA12OSSUtteranceCSgvp":{"name":"utterance","abstract":"
                                                                                                                                                                                          The object used to enable translation of strings to synthsized voice.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C12audioSessionSo07AVAudioD0Cvp":{"name":"audioSession","abstract":"
                                                                                                                                                                                          Audio Session can be overriden should you choose to.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C3srpSo18SFSpeechRecognizerCmvp":{"name":"srp","abstract":"
                                                                                                                                                                                          This property handles permission authorization.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C17speechSynthesizerACSo08AVSpeechD0C_tcfc":{"name":"init(speechSynthesizer:)","abstract":"
                                                                                                                                                                                          Allow injection of the AVSpeechSynthesizer so that caller can be AVSpeechSynthesizerDelegate","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C6sharedACvpZ":{"name":"shared","abstract":"
                                                                                                                                                                                          A singleton object to ensure conformity accross the application it is used in.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C9speakTextyySSSgF":{"name":"speakText(_:)","abstract":"
                                                                                                                                                                                          Pass in a string to speak.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C19speakAttributedText010attributedE0ySo18NSAttributedStringC_tF":{"name":"speakAttributedText(attributedText:)","abstract":"
                                                                                                                                                                                          Pass in an attributed string to speak.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C13pauseSpeakingyyF":{"name":"pauseSpeaking()","abstract":"
                                                                                                                                                                                          Pause speaking text
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C16continueSpeakingyyF":{"name":"continueSpeaking()","abstract":"
                                                                                                                                                                                          Continue speaking text
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C12stopSpeakingyyF":{"name":"stopSpeaking()","abstract":"
                                                                                                                                                                                          Force the ending of speaking.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C11recordVoice20requestMicPermissionySb_tF":{"name":"recordVoice(requestMicPermission:)","abstract":"
                                                                                                                                                                                          Record and recognise speech
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C17endVoiceRecordingyyF":{"name":"endVoiceRecording()","abstract":"
                                                                                                                                                                                          End recording of speech session if one exists.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTask:didFinishSuccessfully:":{"name":"speechRecognitionTask(_:didFinishSuccessfully:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognitionTaskDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTask:didHypothesizeTranscription:":{"name":"speechRecognitionTask(_:didHypothesizeTranscription:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognitionTaskDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTask:didFinishRecognition:":{"name":"speechRecognitionTask(_:didFinishRecognition:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognitionTaskDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionDidDetectSpeech:":{"name":"speechRecognitionDidDetectSpeech(_:)","abstract":"
                                                                                                                                                                                          Called when the recognizer detects speech in the audio stream.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTaskFinishedReadingAudio:":{"name":"speechRecognitionTaskFinishedReadingAudio(_:)","abstract":"
                                                                                                                                                                                          Called when the recognizer has finished reading audio from the request.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognizer:availabilityDidChange:":{"name":"speechRecognizer(_:availabilityDidChange:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognizerDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html":{"name":"OSSSpeech","abstract":"
                                                                                                                                                                                          Speech is the primary interface. To use, set the voice and then call .speak(string: "your string")
                                                                                                                                                                                          "},"Classes/OSSSpeechEngine.html":{"name":"OSSSpeechEngine","abstract":"
                                                                                                                                                                                          Instance-based, main-actor-isolated speech synthesis and recognition engine.
                                                                                                                                                                                          "},"Classes/OSSSpeechUtility.html":{"name":"OSSSpeechUtility","abstract":"
                                                                                                                                                                                          Utility methods for localized strings and diagnostics used by OSSSpeechKit.
                                                                                                                                                                                          "},"Classes/OSSUtterance.html":{"name":"OSSUtterance","abstract":"
                                                                                                                                                                                          OSSUtterance is a wrapper of the AVSpeechUtterance class.
                                                                                                                                                                                          "},"Classes/OSSVoice.html":{"name":"OSSVoice","abstract":"
                                                                                                                                                                                          OSSVoice overides some of the properties provided to enable setting as well as getting.
                                                                                                                                                                                          "},"Classes.html":{"name":"Classes","abstract":"
                                                                                                                                                                                          The following classes are available globally.
                                                                                                                                                                                          "},"Enums.html":{"name":"Enumerations","abstract":"
                                                                                                                                                                                          The following enumerations are available globally.
                                                                                                                                                                                          "},"Extensions.html":{"name":"Extensions","abstract":"
                                                                                                                                                                                          The following extensions are available globally.
                                                                                                                                                                                          "},"Protocols.html":{"name":"Protocols","abstract":"
                                                                                                                                                                                          The following protocols are available globally.
                                                                                                                                                                                          "},"Structs.html":{"name":"Structures","abstract":"
                                                                                                                                                                                          The following structures are available globally.
                                                                                                                                                                                          "}}
\ No newline at end of file
diff --git a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/docSet.dsidx b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/docSet.dsidx
index 87d3847..6502614 100644
Binary files a/docs/docsets/OSSSpeechKit.docset/Contents/Resources/docSet.dsidx and b/docs/docsets/OSSSpeechKit.docset/Contents/Resources/docSet.dsidx differ
diff --git a/docs/docsets/OSSSpeechKit.tgz b/docs/docsets/OSSSpeechKit.tgz
index 566a3eb..6c20af6 100644
Binary files a/docs/docsets/OSSSpeechKit.tgz and b/docs/docsets/OSSSpeechKit.tgz differ
diff --git a/docs/img/spinner.gif b/docs/img/spinner.gif
new file mode 100644
index 0000000..e3038d0
Binary files /dev/null and b/docs/img/spinner.gif differ
diff --git a/docs/index.html b/docs/index.html
index 0cca5e6..49fefd5 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -8,19 +8,27 @@
     
     
     
+    
+    
+    
   
   
     
     
                                                                                                                                                                                          
       
                                                                                                                                                                                          
-        
                                                                                                                                                                                          OSSSpeechKit 0.3.0 Docs (95% documented)
                                                                                                                                                                                          
-        
                                                                                                                                                                                          View on GitHub
                                                                                                                                                                                          
+        
                                                                                                                                                                                          OSSSpeechKit 1.0.0 Docs (100% documented)
                                                                                                                                                                                          
+        
                                                                                                                                                                                          GitHubView on GitHub
                                                                                                                                                                                          
+        
                                                                                                                                                                                          
+          
                                                                                                                                                                                          
+            
+          
                                                                                                                                                                                          
+        
                                                                                                                                                                                          
       
                                                                                                                                                                                          
     
                                                                                                                                                                                          
     
                                                                                                                                                                                          
       
     
                                                                                                                                                                                          
@@ -33,6 +41,12 @@
               
                                                                                                                                                                                        • 
                 OSSSpeech
               
                                                                                                                                                                                          • 
+              
                                                                                                                                                                                        • 
+                OSSSpeechEngine
+              
                                                                                                                                                                                          • 
+              
                                                                                                                                                                                        • 
+                – State
+              
                                                                                                                                                                                          • 
               
                                                                                                                                                                                        • 
                 OSSSpeechUtility
               
                                                                                                                                                                                          • 
@@ -47,12 +61,18 @@
           
                                                                                                                                                                                        • 
             Enumerations
             
                                                                                                                                                                                            
+              
                                                                                                                                                                                          • 
+                OSSSpeechError
+              
                                                                                                                                                                                            • 
               
                                                                                                                                                                                          • 
                 OSSSpeechKitAuthorizationStatus
               
                                                                                                                                                                                            • 
               
                                                                                                                                                                                          • 
                 OSSSpeechKitErrorType
               
                                                                                                                                                                                            • 
+              
                                                                                                                                                                                          • 
+                OSSSpeechRecognitionEvent
+              
                                                                                                                                                                                            • 
               
                                                                                                                                                                                          • 
                 OSSSpeechRecognitionTaskType
               
                                                                                                                                                                                            • 
@@ -64,9 +84,6 @@
           
                                                                                                                                                                                          • 
             Extensions
             
                                                                                                                                                                                              
-              
                                                                                                                                                                                            • 
-                Bundle
-              
                                                                                                                                                                                              • 
               
                                                                                                                                                                                            • 
                 NSObject
               
                                                                                                                                                                                              • 
@@ -83,6 +100,15 @@
           
                                                                                                                                                                                            • 
             Structures
             
                                                                                                                                                                                                
+              
                                                                                                                                                                                              • 
+                OSSLanguage
+              
                                                                                                                                                                                                • 
+              
                                                                                                                                                                                              • 
+                OSSUtteranceConfiguration
+              
                                                                                                                                                                                                • 
+              
                                                                                                                                                                                              • 
+                OSSVoiceConfiguration
+              
                                                                                                                                                                                                • 
               
                                                                                                                                                                                              • 
                 OSSVoiceInfo
               
                                                                                                                                                                                                • 
@@ -96,235 +122,159 @@
             
             
                                                                                                                                                                                                OSSSpeechKit
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                OSSSpeechKit Logo
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                CI Status
-Version
-License
-Platform
-codecov
-docs
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                OSSSpeechKit was developed to provide easier accessibility options to apps. 
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                Apple does not make it easy to get the right voice, nor do they provide a simple way of selecting a language or using speech to text. OSSSpeechKit makes the hassle of trying to find the right language go away. 
                                                                                                                                                                                                
-
                                                                                                                                                                                                Requirements
                                                                                                                                                                                                
+
                                                                                                                                                                                                OSSSpeechKit is an iOS library for speech synthesis and speech recognition built on Apple’s AVFoundation and Speech frameworks.
                                                                                                                                                                                                
+
                                                                                                                                                                                                Requirements
                                                                                                                                                                                                
 
 
                                                                                                                                                                                                  
-
                                                                                                                                                                                                • Swift 5.0 or higher
                                                                                                                                                                                                  • 
-
                                                                                                                                                                                                • iOS 12.0 or higher
                                                                                                                                                                                                  • 
-
                                                                                                                                                                                                • Cocoapods
                                                                                                                                                                                                  • 
-
                                                                                                                                                                                                • A real device
                                                                                                                                                                                                  • 
+
                                                                                                                                                                                                • iOS 17 or later
                                                                                                                                                                                                  • 
+
                                                                                                                                                                                                • Swift 5 language mode or later
                                                                                                                                                                                                  • 
+
                                                                                                                                                                                                • Xcode with Swift 6 package support
                                                                                                                                                                                                  • 
 
                                                                                                                                                                                                
-
                                                                                                                                                                                                Supported Languages
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                 
                                                                                                                                                                                                  English - Australian
                                                                                                                                                                                                🇦🇺                                                                                                                                                                                                 		 Hebrew
                                                                                                                                                                                                🇮🇱                                                                                                                                                                                                 		 Japanese
                                                                                                                                                                                                🇯🇵                                                                                                                                                                                                 		 Romanian
                                                                                                                                                                                                🇷🇴                                                                                                                                                                                                 		 Swedish
                                                                                                                                                                                                🇸🇪                                                                                                                                                                                                 		 Norsk
                                                                                                                                                                                                🇳🇴 
                                                                                                                                                                                                  Portuguese - Brazilian
                                                                                                                                                                                                🇧🇷                                                                                                                                                                                                 		 Hindi - Indian
                                                                                                                                                                                                🇮🇳                                                                                                                                                                                                 		 Korean
                                                                                                                                                                                                🇰🇷                                                                                                                                                                                                 		 Russian
                                                                                                                                                                                                🇷🇺                                                                                                                                                                                                 		 Chinese - Taiwanese
                                                                                                                                                                                                🇹🇼                                                                                                                                                                                                 		 Dutch - Belgium
                                                                                                                                                                                                🇧🇪 
                                                                                                                                                                                                  French - Canadian
                                                                                                                                                                                                🇨🇦                                                                                                                                                                                                 		 Hungarian
                                                                                                                                                                                                🇭🇺                                                                                                                                                                                                 		 Spanish - Mexican
                                                                                                                                                                                                🇲🇽                                                                                                                                                                                                 		 Arabic - Saudi Arabian
                                                                                                                                                                                                🇸🇦                                                                                                                                                                                                 		 Thai
                                                                                                                                                                                                🇹🇭                                                                                                                                                                                                 		 French
                                                                                                                                                                                                🇫🇷 
                                                                                                                                                                                                  Chinese
                                                                                                                                                                                                🇨🇳                                                                                                                                                                                                 		 Indonesian
                                                                                                                                                                                                🇮🇩                                                                                                                                                                                                 		 Norwegian
                                                                                                                                                                                                🇳🇴                                                                                                                                                                                                 		 Slovakian
                                                                                                                                                                                                🇸🇰                                                                                                                                                                                                 		 Turkish
                                                                                                                                                                                                🇹🇷                                                                                                                                                                                                 		 Finnish
                                                                                                                                                                                                🇫🇮 
                                                                                                                                                                                                  Chinese - Hong Kong
                                                                                                                                                                                                🇭🇰                                                                                                                                                                                                 		 English - Irish
                                                                                                                                                                                                🇮🇪                                                                                                                                                                                                 		 Polish
                                                                                                                                                                                                🇵🇱                                                                                                                                                                                                 		 English - South African
                                                                                                                                                                                                🇿🇦                                                                                                                                                                                                 		 English - United States
                                                                                                                                                                                                🇺🇸                                                                                                                                                                                                 		 Danish
                                                                                                                                                                                                🇩🇰 
                                                                                                                                                                                                  Czech
                                                                                                                                                                                                🇨🇿                                                                                                                                                                                                 		 Italian
                                                                                                                                                                                                🇮🇹                                                                                                                                                                                                 		 Portuguese
                                                                                                                                                                                                🇵🇹                                                                                                                                                                                                 		 Spanish
                                                                                                                                                                                                🇪🇸                                                                                                                                                                                                 		 English
                                                                                                                                                                                                🇬🇧                                                                                                                                                                                                		 Dutch
                                                                                                                                                                                                🇳🇱 
                                                                                                                                                                                                  Greek
                                                                                                                                                                                                🇬🇷 
                                                                                                                                                                                                
-
                                                                                                                                                                                                Features
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                OSSSpeechKit offers simple text to speech and speech to text in 37 different languages. 
                                                                                                                                                                                                
+
                                                                                                                                                                                                Installation
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                OSSSpeechKit is built on top of both the AVFoundation and Speech frameworks. 
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                You can achieve text to speech or speech to text in as little as two lines of code. 
                                                                                                                                                                                                
+
                                                                                                                                                                                                In Xcode, choose File > Add Package Dependencies, enter:
                                                                                                                                                                                                
+
                                                                                                                                                                                                https://github.com/AppDevGuy/OSSSpeechKit.git
+
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                The speech will play over the top of other sounds such as music. 
                                                                                                                                                                                                
-
                                                                                                                                                                                                Installation
                                                                                                                                                                                                
+
                                                                                                                                                                                                Select version 1.0.0 or later and add the OSSSpeechKit library product to your app target.
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                OSSSpeechKit is available through CocoaPods. To install
-it, simply add the following line to your Podfile:
                                                                                                                                                                                                
-
                                                                                                                                                                                                pod 'OSSSpeechKit'
+
                                                                                                                                                                                                You can also add it to Package.swift:
                                                                                                                                                                                                
+
                                                                                                                                                                                                dependencies: [
+    .package(
+        url: "https://github.com/AppDevGuy/OSSSpeechKit.git",
+        from: "1.0.0"
+    )
+]
 
                                                                                                                                                                                                
-
                                                                                                                                                                                                Implementation
                                                                                                                                                                                                
-
                                                                                                                                                                                                Text to Speech
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                These methods enable you to pass in a string and hear the text played back using.
                                                                                                                                                                                                
-
                                                                                                                                                                                                Simple
                                                                                                                                                                                                
-
                                                                                                                                                                                                import OSSSpeechKit
+
                                                                                                                                                                                                Swift Package Manager is the only supported installation method. The historical CocoaPods release 0.3.3 remains available for existing builds but is no longer maintained; version 1.0 and later are not published to CocoaPods.
                                                                                                                                                                                                
+
                                                                                                                                                                                                Speech synthesis
                                                                                                                                                                                                
 
-.....
+
                                                                                                                                                                                                OSSSpeechEngine is main-actor isolated and instance based. Select a language from the catalog, confirm that a voice exists on the current device, then speak:
                                                                                                                                                                                                
+
                                                                                                                                                                                                import AVFoundation
+import OSSSpeechKit
 
-// Declare an instance of OSSSpeechKit
-let speechKit = OSSSpeech.shared
-// Set the voice you wish to use - currently upper case for formality or language and country name
-speechKit.voice = OSSVoice(quality: .enhanced, language: .Australian)
-// Set the text in the language you have set
-speechKit.speakText(text: "Hello, my name is OSSSpeechKit.")
-
                                                                                                                                                                                                
-
                                                                                                                                                                                                Advanced
                                                                                                                                                                                                
-
                                                                                                                                                                                                import OSSSpeechKit
+let engine = OSSSpeechEngine()
+let language = OSSLanguage.catalog.first {
+    $0.id == "english-australia"
+}!
 
-.....
+guard !language.availableSynthesisVoices.isEmpty else {
+    // Ask the user to install a compatible system voice.
+    return
+}
 
-// Declare an instance of OSSSpeechKit
-let speechKit = OSSSpeech.shared
-// Create a voice instance
-let newVoice = OSSVoice()
-// Set the language
-newVoice.language = OSSVoiceEnum.Australian.rawValue
-// Set the voice quality
-newVoice.quality = .enhanced
-// Set the voice of the speech kit
-speechKit.voice = newVoice
-// Initialise an utterance
-let utterance = OSSUtterance(string: "Testing")
-// Set the recognition task type 
-speechKit.recognitionTaskType = .dictation
-// Set volume
-utterance.volume = 0.5
-// Set rate of speech
-utterance.rate = 0.5
-// Set the pitch 
-utterance.pitchMultiplier = 1.2
-// Set speech utterance
-speechKit.utterance = utterance
-// Ask to speak
-speechKit.speakText(text: utterance.speechString)
+try await engine.speak(
+    "Hello from OSSSpeechKit.",
+    voice: OSSVoiceConfiguration(
+        language: language,
+        preferredQuality: .enhanced
+    ),
+    configuration: OSSUtteranceConfiguration(
+        rate: AVSpeechUtteranceDefaultSpeechRate,
+        pitchMultiplier: 1,
+        volume: 1
+    )
+)
 
                                                                                                                                                                                                
-
                                                                                                                                                                                                Speech to Text
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                Currently speech to text is offered in a very simple format. Starting and stopping of recording is handled by the app. 
                                                                                                                                                                                                
-
                                                                                                                                                                                                iOS 13 On-Device Speech to Text support is now available as of 0.3.0 🎉
                                                                                                                                                                                                
+
                                                                                                                                                                                                Use pauseSpeaking(), continueSpeaking(), and stopSpeaking() to control playback.
                                                                                                                                                                                                
+
                                                                                                                                                                                                Speech recognition
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                SpeechKit implements delegates to handle the recording authorization, output of text and failure to record.
                                                                                                                                                                                                
-
                                                                                                                                                                                                speechKit.delegate = self
-// Call to start and end recording. 
-speechKit.recordVoice()
-// Call to end recording
-speechKit.endVoiceRecording()
+
                                                                                                                                                                                                Add both usage descriptions to the consuming app’s Info.plist:
                                                                                                                                                                                                
+
                                                                                                                                                                                                <key>NSMicrophoneUsageDescription</key>
+<string>Explain why your app records audio.</string>
+<key>NSSpeechRecognitionUsageDescription</key>
+<string>Explain why your app transcribes speech.</string>
 
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                It is important that you have included in your info.plist the following:
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                
-
                                                                                                                                                                                                Privacy - Speech Recognition Usage Description
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                Privacy - Microphone Usage Description
                                                                                                                                                                                                
-
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                Without these, you will not be able to access the microphone nor speech recognition.
                                                                                                                                                                                                
-
                                                                                                                                                                                                Delegates
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                Handle returning authentication status to user - primary use is for non-authorized state.
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                
-
                                                                                                                                                                                                func authorizationToMicrophone(withAuthentication type: OSSSpeechKitAuthorizationStatus)
                                                                                                                                                                                                
-
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                When the microphone has finished accepting audio, this delegate will be called with the final best text output.
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                
-
                                                                                                                                                                                                func didFailToCommenceSpeechRecording()
                                                                                                                                                                                                
-
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                If the speech recogniser and request fail to set up, this method will be called.
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                
-
                                                                                                                                                                                                func didFinishListening(withText text: String)
                                                                                                                                                                                                
-
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                For further information you can check out the Apple documentation directly.
                                                                                                                                                                                                
-
                                                                                                                                                                                                Other Features
                                                                                                                                                                                                
-
                                                                                                                                                                                                List all available voices:
                                                                                                                                                                                                
-
                                                                                                                                                                                                let allLanguages = OSSVoiceEnum.allCases
-
                                                                                                                                                                                                
-
                                                                                                                                                                                                Get specific voice information:
                                                                                                                                                                                                
-
                                                                                                                                                                                                // All support languages
-let allVoices = OSSVoiceEnum.allCases
-// Language details
-let languageInformation = allVoices[0].getDetails()
-// Flag of country
-let flag = allVoices[0].flag
+
                                                                                                                                                                                                Then consume recognition events:
                                                                                                                                                                                                
+
                                                                                                                                                                                                let engine = OSSSpeechEngine()
+
+do {
+    let events = try await engine.recognitionEvents(
+        locale: Locale(identifier: "en-AU")
+    )
+
+    for try await event in events {
+        switch event {
+        case .partial(let text):
+            print("Partial:", text)
+        case .completed(let text):
+            print("Final:", text)
+        case .availabilityChanged(let available):
+            print("Available:", available)
+        case .cancelled:
+            break
+        }
+    }
+} catch {
+    print("Recognition failed:", error)
+}
 
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                The getDetails() method returns a struct containing:
                                                                                                                                                                                                
-
                                                                                                                                                                                                OSSVoiceInfo {
-    /// The name of the voice; All AVSpeechSynthesisVoice instances have a persons name.
-    var name: String?
-    /// The name of the language being used.
-    var language: String?
-    /// The language code is what is internationally used in Locale settings.
-    var languageCode: String?
-    /// Identifier is a unique bundle url provided by Apple for each AVSpeechSynthesisVoice.
-    var identifier: Any?
+
                                                                                                                                                                                                Call cancelRecognition() to stop an active session. Set usesOnDeviceRecognition = true before starting if your product requires on-device recognition; the operation fails when the selected recognizer does not support it.
                                                                                                                                                                                                
+
                                                                                                                                                                                                Languages, voices, and flags
                                                                                                                                                                                                
+
+
                                                                                                                                                                                                OSSLanguage.catalog is display metadata, not a guarantee of runtime support. Availability varies by OS release, device, installed voice assets, region, network access, and Apple’s services.
                                                                                                                                                                                                
+
+
                                                                                                                                                                                                The catalog was reconciled against Apple’s current
+VoiceOver language support and
+feature availability pages.
+Exact synthesis voices come from
+AVSpeechSynthesisVoice.speechVoices()
+and recognition locales come from
+SFSpeechRecognizer.supportedLocales();
+those runtime results are authoritative.
                                                                                                                                                                                                
+
+
                                                                                                                                                                                                Check capabilities when presenting an option:
                                                                                                                                                                                                
+
                                                                                                                                                                                                for language in OSSLanguage.catalog {
+    let canSpeak = !language.availableSynthesisVoices.isEmpty
+    let canRecognize = language.supportsRecognition
+    let flag = language.flagEmoji
+    print(flag, language.name, canSpeak, canRecognize)
 }
 
                                                                                                                                                                                                
-
                                                                                                                                                                                                Other Info
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                The OSSVoiceEnum contains other methods, such as a hello message, title variable and subtitle variable so you can use it in a list. 
                                                                                                                                                                                                
+
                                                                                                                                                                                                For UIKit code that needs an image, use:
                                                                                                                                                                                                
+
                                                                                                                                                                                                let image = language.renderedFlagImage(pointSize: 24)
+
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                You can also set the speech:
                                                                                                                                                                                                
+
                                                                                                                                                                                                Speech synthesis is not translation. Supply text written for the selected language and locale.
                                                                                                                                                                                                
+
                                                                                                                                                                                                Privacy
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                  
-
                                                                                                                                                                                                • volume
                                                                                                                                                                                                  • 
-
                                                                                                                                                                                                • pitchMultiplier
                                                                                                                                                                                                  • 
-
                                                                                                                                                                                                • rate
                                                                                                                                                                                                  • 
-
                                                                                                                                                                                                
+
                                                                                                                                                                                                OSSSpeechKit requests microphone and speech-recognition permission only when your app asks it to. Your app is responsible for clear NSMicrophoneUsageDescription and NSSpeechRecognitionUsageDescription strings and for disclosing its own data practices.
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                As well as using an NSAttributedString.
                                                                                                                                                                                                
+
                                                                                                                                                                                                Speech recognition may use Apple services unless on-device recognition is requested and supported. Review Apple’s current Speech framework and App Store privacy requirements for your use case.
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                There are plans to implement flags for each country as well as some more features, such as being able to play the voice if the device is on silent. 
                                                                                                                                                                                                
+
                                                                                                                                                                                                The included PrivacyInfo.xcprivacy declares that OSSSpeechKit itself does not track users, collect data, or access a required-reason API. It does not replace the consuming app’s privacy manifest or App Privacy answers.
                                                                                                                                                                                                
+
                                                                                                                                                                                                Migrating from pre-1.0
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                If the language or voice you require is not available, this is either due to:
                                                                                                                                                                                                
+
                                                                                                                                                                                                The singleton and subclass-based APIs remain temporarily available but are deprecated:
                                                                                                                                                                                                
 
 
-
                                                                                                                                                                                                Important Information
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                Apple do not make the voice of Siri available for use. 
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                This kit provides Apple’s AVFoundation voices available and easy to use, so you do not need to know all the voice codes, among many other things.
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                To say things correctly in each language, you need to set the voice to the correct language and supply that languages text; this SDK is not a translator. 
                                                                                                                                                                                                
-
                                                                                                                                                                                                Code Example:
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                You wish for you app to use a Chinese voice, you will need to ensure the text being passed in is Chinese. 
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                Disclaimer: I do not know how to speak Chinese, I have used Google translate for the Chinese characters.
                                                                                                                                                                                                
-
                                                                                                                                                                                                Correct:
                                                                                                                                                                                                
-
                                                                                                                                                                                                speechKit.voice = OSSVoice(quality: .enhanced, language: .Chinese)
-speechKit.speakText(text: "你好我的名字是 ...")
-
                                                                                                                                                                                                
-
                                                                                                                                                                                                Incorrect:
                                                                                                                                                                                                
-
                                                                                                                                                                                                speechKit.voice = OSSVoice(quality: .enhanced, language: .Australian)
-speechKit.speakText(text: "你好我的名字是 ...")
-
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                OR
                                                                                                                                                                                                
-
                                                                                                                                                                                                speechKit.voice = OSSVoice(quality: .enhanced, language: .Chinese)
-speechKit.speakText(text: "Hello, my name is ...")
-
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                This same principle applies to all other languages such as German, Saudi Arabian, French, etc.. Failing to set the language for the text you wish to be spoken will not sound correct. 
                                                                                                                                                                                                
-
                                                                                                                                                                                                Contributions and Queries
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                If you have a question, please create a ticket or email me directly. 
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                If you wish to contribute, please create a pull request. 
                                                                                                                                                                                                
-
                                                                                                                                                                                                Example Project
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                To run the example project, clone the repo, and run pod install from the Example directory first.
                                                                                                                                                                                                
-
                                                                                                                                                                                                Unit Tests
                                                                                                                                                                                                
-
-
                                                                                                                                                                                                For further examples, please look at the Unit Test class.
                                                                                                                                                                                                
-
                                                                                                                                                                                                Author
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                App Dev Guy
                                                                                                                                                                                                
+
                                                                                                                                                                                                See MIGRATION.md for examples and behavior changes.
                                                                                                                                                                                                
+
                                                                                                                                                                                                Example and tests
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                profile for App Dev Guy at Stack Overflow, Q&A for professional and enthusiast programmers
                                                                                                                                                                                                
-
                                                                                                                                                                                                License
                                                                                                                                                                                                
+
                                                                                                                                                                                                Open Example/OSSSpeechKit.xcodeproj to run the example app and its tests. The project links the package from the repository root.
                                                                                                                                                                                                
+
                                                                                                                                                                                                License
                                                                                                                                                                                                
 
-
                                                                                                                                                                                                OSSSpeechKit is available under the MIT license. See the LICENSE file for more info.
                                                                                                                                                                                                
+
                                                                                                                                                                                                OSSSpeechKit is available under the MIT license. See LICENSE.
                                                                                                                                                                                                
 
           
         
         
       
     
                                                                                                                                                                                          • 
   
-
                                                                                                                                                                                          
 
diff --git a/docs/js/jazzy.js b/docs/js/jazzy.js
index 1e55d6e..1984416 100755
--- a/docs/js/jazzy.js
+++ b/docs/js/jazzy.js
@@ -1,3 +1,7 @@
+// Jazzy - https://github.com/realm/jazzy
+// Copyright Realm Inc.
+// SPDX-License-Identifier: MIT
+
 window.jazzy = {'docset': false}
 if (typeof window.dash != 'undefined') {
   document.documentElement.className += ' dash'
diff --git a/docs/js/jazzy.search.js b/docs/js/jazzy.search.js
new file mode 100644
index 0000000..359cdbb
--- /dev/null
+++ b/docs/js/jazzy.search.js
@@ -0,0 +1,74 @@
+// Jazzy - https://github.com/realm/jazzy
+// Copyright Realm Inc.
+// SPDX-License-Identifier: MIT
+
+$(function(){
+  var $typeahead = $('[data-typeahead]');
+  var $form = $typeahead.parents('form');
+  var searchURL = $form.attr('action');
+
+  function displayTemplate(result) {
+    return result.name;
+  }
+
+  function suggestionTemplate(result) {
+    var t = '
                                                                                                                                                                                          ';
+    t += '' + result.name + '';
+    if (result.parent_name) {
+     t += '' + result.parent_name + '';
+    }
+    t += '
                                                                                                                                                                                          ';
+    return t;
+  }
+
+  $typeahead.one('focus', function() {
+    $form.addClass('loading');
+
+    $.getJSON(searchURL).then(function(searchData) {
+      const searchIndex = lunr(function() {
+        this.ref('url');
+        this.field('name');
+        this.field('abstract');
+        for (const [url, doc] of Object.entries(searchData)) {
+          this.add({url: url, name: doc.name, abstract: doc.abstract});
+        }
+      });
+
+      $typeahead.typeahead(
+        {
+          highlight: true,
+          minLength: 3,
+          autoselect: true
+        },
+        {
+          limit: 10,
+          display: displayTemplate,
+          templates: { suggestion: suggestionTemplate },
+          source: function(query, sync) {
+            const lcSearch = query.toLowerCase();
+            const results = searchIndex.query(function(q) {
+                q.term(lcSearch, { boost: 100 });
+                q.term(lcSearch, {
+                  boost: 10,
+                  wildcard: lunr.Query.wildcard.TRAILING
+                });
+            }).map(function(result) {
+              var doc = searchData[result.ref];
+              doc.url = result.ref;
+              return doc;
+            });
+            sync(results);
+          }
+        }
+      );
+      $form.removeClass('loading');
+      $typeahead.trigger('focus');
+    });
+  });
+
+  var baseURL = searchURL.slice(0, -"search.json".length);
+
+  $typeahead.on('typeahead:select', function(e, result) {
+    window.location = baseURL + result.url;
+  });
+});
diff --git a/docs/js/jquery.min.js b/docs/js/jquery.min.js
index a1c07fd..2c69bc9 100644
--- a/docs/js/jquery.min.js
+++ b/docs/js/jquery.min.js
@@ -1,2 +1,2 @@
-/*! jQuery v3.4.1 | (c) JS Foundation and other contributors | jquery.org/license */
-!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],E=C.document,r=Object.getPrototypeOf,s=t.slice,g=t.concat,u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.4.1",k=function(e,t){return new k.fn.init(e,t)},p=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g;function d(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp($),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+$),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),ne=function(e,t,n){var r="0x"+t-65536;return r!=r||n?t:r<0?String.fromCharCode(r+65536):String.fromCharCode(r>>10|55296,1023&r|56320)},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(m.childNodes),m.childNodes),t[m.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&((e?e.ownerDocument||e:m)!==C&&T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!A[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&U.test(t)){(s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=k),o=(l=h(t)).length;while(o--)l[o]="#"+s+" "+xe(l[o]);c=l.join(","),f=ee.test(t)&&ye(e.parentNode)||e}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){A(t,!0)}finally{s===k&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[k]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:m;return r!==C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),m!==C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=k,!C.getElementsByName||!C.getElementsByName(k).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+k+"-]").length||v.push("~="),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+k+"+*").length||v.push(".#.+[+~]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",$)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)===(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e===C||e.ownerDocument===m&&y(m,e)?-1:t===C||t.ownerDocument===m&&y(m,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e===C?-1:t===C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]===m?-1:s[r]===m?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if((e.ownerDocument||e)!==C&&T(e),d.matchesSelector&&E&&!A[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){A(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=p[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&p(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?k.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?k.grep(e,function(e){return e===n!==r}):"string"!=typeof n?k.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(k.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||q,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:L.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof k?t[0]:t,k.merge(this,k.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),D.test(r[1])&&k.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(k):k.makeArray(e,this)}).prototype=k.fn,q=k(E);var H=/^(?:parents|prev(?:Until|All))/,O={children:!0,contents:!0,next:!0,prev:!0};function P(e,t){while((e=e[t])&&1!==e.nodeType);return e}k.fn.extend({has:function(e){var t=k(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i,ge={option:[1,""],thead:[1,"","
                                                                                                                                                                                          "],col:[2,"","
                                                                                                                                                                                          "],tr:[2,"","
                                                                                                                                                                                          "],td:[3,"","
                                                                                                                                                                                          "],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?k.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;nx",y.noCloneChecked=!!me.cloneNode(!0).lastChild.defaultValue;var Te=/^key/,Ce=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,Ee=/^([^.]*)(?:\.(.+)|)/;function ke(){return!0}function Se(){return!1}function Ne(e,t){return e===function(){try{return E.activeElement}catch(e){}}()==("focus"===t)}function Ae(e,t,n,r,i,o){var a,s;if("object"==typeof t){for(s in"string"!=typeof n&&(r=r||n,n=void 0),t)Ae(e,s,n,r,t[s],o);return e}if(null==r&&null==i?(i=n,r=n=void 0):null==i&&("string"==typeof n?(i=r,r=void 0):(i=r,r=n,n=void 0)),!1===i)i=Se;else if(!i)return e;return 1===o&&(a=i,(i=function(e){return k().off(e),a.apply(this,arguments)}).guid=a.guid||(a.guid=k.guid++)),e.each(function(){k.event.add(this,t,i,r,n)})}function De(e,i,o){o?(Q.set(e,i,!1),k.event.add(e,i,{namespace:!1,handler:function(e){var t,n,r=Q.get(this,i);if(1&e.isTrigger&&this[i]){if(r.length)(k.event.special[i]||{}).delegateType&&e.stopPropagation();else if(r=s.call(arguments),Q.set(this,i,r),t=o(this,i),this[i](),r!==(n=Q.get(this,i))||t?Q.set(this,i,!1):n={},r!==n)return e.stopImmediatePropagation(),e.preventDefault(),n.value}else r.length&&(Q.set(this,i,{value:k.event.trigger(k.extend(r[0],k.Event.prototype),r.slice(1),this)}),e.stopImmediatePropagation())}})):void 0===Q.get(e,i)&&k.event.add(e,i,ke)}k.event={global:{},add:function(t,e,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.get(t);if(v){n.handler&&(n=(o=n).handler,i=o.selector),i&&k.find.matchesSelector(ie,i),n.guid||(n.guid=k.guid++),(u=v.events)||(u=v.events={}),(a=v.handle)||(a=v.handle=function(e){return"undefined"!=typeof k&&k.event.triggered!==e.type?k.event.dispatch.apply(t,arguments):void 0}),l=(e=(e||"").match(R)||[""]).length;while(l--)d=g=(s=Ee.exec(e[l])||[])[1],h=(s[2]||"").split(".").sort(),d&&(f=k.event.special[d]||{},d=(i?f.delegateType:f.bindType)||d,f=k.event.special[d]||{},c=k.extend({type:d,origType:g,data:r,handler:n,guid:n.guid,selector:i,needsContext:i&&k.expr.match.needsContext.test(i),namespace:h.join(".")},o),(p=u[d])||((p=u[d]=[]).delegateCount=0,f.setup&&!1!==f.setup.call(t,r,h,a)||t.addEventListener&&t.addEventListener(d,a)),f.add&&(f.add.call(t,c),c.handler.guid||(c.handler.guid=n.guid)),i?p.splice(p.delegateCount++,0,c):p.push(c),k.event.global[d]=!0)}},remove:function(e,t,n,r,i){var o,a,s,u,l,c,f,p,d,h,g,v=Q.hasData(e)&&Q.get(e);if(v&&(u=v.events)){l=(t=(t||"").match(R)||[""]).length;while(l--)if(d=g=(s=Ee.exec(t[l])||[])[1],h=(s[2]||"").split(".").sort(),d){f=k.event.special[d]||{},p=u[d=(r?f.delegateType:f.bindType)||d]||[],s=s[2]&&new RegExp("(^|\\.)"+h.join("\\.(?:.*\\.|)")+"(\\.|$)"),a=o=p.length;while(o--)c=p[o],!i&&g!==c.origType||n&&n.guid!==c.guid||s&&!s.test(c.namespace)||r&&r!==c.selector&&("**"!==r||!c.selector)||(p.splice(o,1),c.selector&&p.delegateCount--,f.remove&&f.remove.call(e,c));a&&!p.length&&(f.teardown&&!1!==f.teardown.call(e,h,v.handle)||k.removeEvent(e,d,v.handle),delete u[d])}else for(d in u)k.event.remove(e,d+t[l],n,r,!0);k.isEmptyObject(u)&&Q.remove(e,"handle events")}},dispatch:function(e){var t,n,r,i,o,a,s=k.event.fix(e),u=new Array(arguments.length),l=(Q.get(this,"events")||{})[s.type]||[],c=k.event.special[s.type]||{};for(u[0]=s,t=1;t\x20\t\r\n\f]*)[^>]*)\/>/gi,qe=/\s*$/g;function Oe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&k(e).children("tbody")[0]||e}function Pe(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function Re(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Me(e,t){var n,r,i,o,a,s,u,l;if(1===t.nodeType){if(Q.hasData(e)&&(o=Q.access(e),a=Q.set(t,o),l=o.events))for(i in delete a.handle,a.events={},l)for(n=0,r=l[i].length;n")},clone:function(e,t,n){var r,i,o,a,s,u,l,c=e.cloneNode(!0),f=oe(e);if(!(y.noCloneChecked||1!==e.nodeType&&11!==e.nodeType||k.isXMLDoc(e)))for(a=ve(c),r=0,i=(o=ve(e)).length;r").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Vt,Gt=[],Yt=/(=)\?(?=&|$)|\?\?/;k.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Gt.pop()||k.expando+"_"+kt++;return this[e]=!0,e}}),k.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Yt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Yt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Yt,"$1"+r):!1!==e.jsonp&&(e.url+=(St.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||k.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?k(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Gt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Vt=E.implementation.createHTMLDocument("").body).innerHTML="
                                                                                                                                                                                          ",2===Vt.childNodes.length),k.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=D.exec(e))?[t.createElement(i[1])]:(i=we([e],t,o),o&&o.length&&k(o).remove(),k.merge([],i.childNodes)));var r,i,o},k.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(k.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},k.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){k.fn[t]=function(e){return this.on(t,e)}}),k.expr.pseudos.animated=function(t){return k.grep(k.timers,function(e){return t===e.elem}).length},k.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=k.css(e,"position"),c=k(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=k.css(e,"top"),u=k.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,k.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},k.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){k.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===k.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===k.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=k(e).offset()).top+=k.css(e,"borderTopWidth",!0),i.left+=k.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-k.css(r,"marginTop",!0),left:t.left-i.left-k.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===k.css(e,"position"))e=e.offsetParent;return e||ie})}}),k.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;k.fn[t]=function(e){return _(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),k.each(["top","left"],function(e,n){k.cssHooks[n]=ze(y.pixelPosition,function(e,t){if(t)return t=_e(e,n),$e.test(t)?k(e).position()[n]+"px":t})}),k.each({Height:"height",Width:"width"},function(a,s){k.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){k.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return _(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?k.css(e,t,i):k.style(e,t,n,i)},s,n?e:void 0,n)}})}),k.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){k.fn[n]=function(e,t){return 0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
                                                                                                                                                                                          "],col:[2,"","
                                                                                                                                                                                          "],tr:[2,"","
                                                                                                                                                                                          "],td:[3,"","
                                                                                                                                                                                          "],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
                                                                                                                                                                                          ",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 00){var c=e.utils.clone(r)||{};c.position=[a,l],c.index=s.length,s.push(new e.Token(i.slice(a,o),c))}a=o+1}}return s},e.tokenizer.separator=/[\s\-]+/,e.Pipeline=function(){this._stack=[]},e.Pipeline.registeredFunctions=Object.create(null),e.Pipeline.registerFunction=function(t,r){r in this.registeredFunctions&&e.utils.warn("Overwriting existing registered function: "+r),t.label=r,e.Pipeline.registeredFunctions[t.label]=t},e.Pipeline.warnIfFunctionNotRegistered=function(t){var r=t.label&&t.label in this.registeredFunctions;r||e.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",t)},e.Pipeline.load=function(t){var r=new e.Pipeline;return t.forEach(function(t){var i=e.Pipeline.registeredFunctions[t];if(!i)throw new Error("Cannot load unregistered function: "+t);r.add(i)}),r},e.Pipeline.prototype.add=function(){var t=Array.prototype.slice.call(arguments);t.forEach(function(t){e.Pipeline.warnIfFunctionNotRegistered(t),this._stack.push(t)},this)},e.Pipeline.prototype.after=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,r)},e.Pipeline.prototype.before=function(t,r){e.Pipeline.warnIfFunctionNotRegistered(r);var i=this._stack.indexOf(t);if(i==-1)throw new Error("Cannot find existingFn");this._stack.splice(i,0,r)},e.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);t!=-1&&this._stack.splice(t,1)},e.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=n),s!=e);)i=r-t,n=t+Math.floor(i/2),s=this.elements[2*n];return s==e?2*n:s>e?2*n:sa?l+=2:o==a&&(t+=r[u+1]*i[l+1],u+=2,l+=2);return t},e.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},e.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var o,a=s.str.charAt(0);a in s.node.edges?o=s.node.edges[a]:(o=new e.TokenSet,s.node.edges[a]=o),1==s.str.length&&(o["final"]=!0),n.push({node:o,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(0!=s.editsRemaining){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new e.TokenSet;s.node.edges["*"]=u}if(0==s.str.length&&(u["final"]=!0),n.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&n.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),1==s.str.length&&(s.node["final"]=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new e.TokenSet;s.node.edges["*"]=l}1==s.str.length&&(l["final"]=!0),n.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var c,h=s.str.charAt(0),d=s.str.charAt(1);d in s.node.edges?c=s.node.edges[d]:(c=new e.TokenSet,s.node.edges[d]=c),1==s.str.length&&(c["final"]=!0),n.push({node:c,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return i},e.TokenSet.fromString=function(t){for(var r=new e.TokenSet,i=r,n=0,s=t.length;n=e;t--){var r=this.uncheckedNodes[t],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r["char"]]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}},e.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},e.Index.prototype.search=function(t){return this.query(function(r){var i=new e.QueryParser(t,r);i.parse()})},e.Index.prototype.query=function(t){for(var r=new e.Query(this.fields),i=Object.create(null),n=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),u=0;u1?this._b=1:this._b=e},e.Builder.prototype.k1=function(e){this._k1=e},e.Builder.prototype.add=function(t,r){var i=t[this._ref],n=Object.keys(this._fields);this._documents[i]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){var t,r;do t=this.next(),r=t.charCodeAt(0);while(r>47&&r<58);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos1&&(t.backup(),t.emit(e.QueryLexer.TERM)),t.ignore(),t.more())return e.QueryLexer.lexText},e.QueryLexer.lexEditDistance=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.EDIT_DISTANCE),e.QueryLexer.lexText},e.QueryLexer.lexBoost=function(t){return t.ignore(),t.acceptDigitRun(),t.emit(e.QueryLexer.BOOST),e.QueryLexer.lexText},e.QueryLexer.lexEOS=function(t){t.width()>0&&t.emit(e.QueryLexer.TERM)},e.QueryLexer.termSeparator=e.tokenizer.separator,e.QueryLexer.lexText=function(t){for(;;){var r=t.next();if(r==e.QueryLexer.EOS)return e.QueryLexer.lexEOS;if(92!=r.charCodeAt(0)){if(":"==r)return e.QueryLexer.lexField;if("~"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexEditDistance;if("^"==r)return t.backup(),t.width()>0&&t.emit(e.QueryLexer.TERM),e.QueryLexer.lexBoost;if("+"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if("-"==r&&1===t.width())return t.emit(e.QueryLexer.PRESENCE),e.QueryLexer.lexText;if(r.match(e.QueryLexer.termSeparator))return e.QueryLexer.lexTerm}else t.escapeCharacter()}},e.QueryParser=function(t,r){this.lexer=new e.QueryLexer(t),this.query=r,this.currentClause={},this.lexemeIdx=0},e.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var t=e.QueryParser.parseClause;t;)t=t(this);return this.query},e.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},e.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},e.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},e.QueryParser.parseClause=function(t){var r=t.peekLexeme();if(void 0!=r)switch(r.type){case e.QueryLexer.PRESENCE:return e.QueryParser.parsePresence;case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(i+=" with value '"+r.str+"'"),new e.QueryParseError(i,r.start,r.end)}},e.QueryParser.parsePresence=function(t){var r=t.consumeLexeme();if(void 0!=r){switch(r.str){case"-":t.currentClause.presence=e.Query.presence.PROHIBITED;break;case"+":t.currentClause.presence=e.Query.presence.REQUIRED;break;default:var i="unrecognised presence operator'"+r.str+"'";throw new e.QueryParseError(i,r.start,r.end)}var n=t.peekLexeme();if(void 0==n){var i="expecting term or field, found nothing";throw new e.QueryParseError(i,r.start,r.end)}switch(n.type){case e.QueryLexer.FIELD:return e.QueryParser.parseField;case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var i="expecting term or field, found '"+n.type+"'";throw new e.QueryParseError(i,n.start,n.end)}}},e.QueryParser.parseField=function(t){var r=t.consumeLexeme();if(void 0!=r){if(t.query.allFields.indexOf(r.str)==-1){var i=t.query.allFields.map(function(e){return"'"+e+"'"}).join(", "),n="unrecognised field '"+r.str+"', possible fields: "+i;throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.fields=[r.str];var s=t.peekLexeme();if(void 0==s){var n="expecting term, found nothing";throw new e.QueryParseError(n,r.start,r.end)}switch(s.type){case e.QueryLexer.TERM:return e.QueryParser.parseTerm;default:var n="expecting term, found '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseTerm=function(t){var r=t.consumeLexeme();if(void 0!=r){t.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(t.currentClause.usePipeline=!1);var i=t.peekLexeme();if(void 0==i)return void t.nextClause();switch(i.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+i.type+"'";throw new e.QueryParseError(n,i.start,i.end)}}},e.QueryParser.parseEditDistance=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="edit distance must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.editDistance=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},e.QueryParser.parseBoost=function(t){var r=t.consumeLexeme();if(void 0!=r){var i=parseInt(r.str,10);if(isNaN(i)){var n="boost must be numeric";throw new e.QueryParseError(n,r.start,r.end)}t.currentClause.boost=i;var s=t.peekLexeme();if(void 0==s)return void t.nextClause();switch(s.type){case e.QueryLexer.TERM:return t.nextClause(),e.QueryParser.parseTerm;case e.QueryLexer.FIELD:return t.nextClause(),e.QueryParser.parseField;case e.QueryLexer.EDIT_DISTANCE:return e.QueryParser.parseEditDistance;case e.QueryLexer.BOOST:return e.QueryParser.parseBoost;case e.QueryLexer.PRESENCE:return t.nextClause(),e.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+s.type+"'";throw new e.QueryParseError(n,s.start,s.end)}}},function(e,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():e.lunr=t()}(this,function(){return e})}();
diff --git a/docs/js/typeahead.jquery.js b/docs/js/typeahead.jquery.js
new file mode 100644
index 0000000..3a2d2ab
--- /dev/null
+++ b/docs/js/typeahead.jquery.js
@@ -0,0 +1,1694 @@
+/*!
+ * typeahead.js 1.3.1
+ * https://github.com/corejavascript/typeahead.js
+ * Copyright 2013-2020 Twitter, Inc. and other contributors; Licensed MIT
+ */
+
+
+(function(root, factory) {
+    if (typeof define === "function" && define.amd) {
+        define([ "jquery" ], function(a0) {
+            return factory(a0);
+        });
+    } else if (typeof module === "object" && module.exports) {
+        module.exports = factory(require("jquery"));
+    } else {
+        factory(root["jQuery"]);
+    }
+})(this, function($) {
+    var _ = function() {
+        "use strict";
+        return {
+            isMsie: function() {
+                return /(msie|trident)/i.test(navigator.userAgent) ? navigator.userAgent.match(/(msie |rv:)(\d+(.\d+)?)/i)[2] : false;
+            },
+            isBlankString: function(str) {
+                return !str || /^\s*$/.test(str);
+            },
+            escapeRegExChars: function(str) {
+                return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&");
+            },
+            isString: function(obj) {
+                return typeof obj === "string";
+            },
+            isNumber: function(obj) {
+                return typeof obj === "number";
+            },
+            isArray: $.isArray,
+            isFunction: $.isFunction,
+            isObject: $.isPlainObject,
+            isUndefined: function(obj) {
+                return typeof obj === "undefined";
+            },
+            isElement: function(obj) {
+                return !!(obj && obj.nodeType === 1);
+            },
+            isJQuery: function(obj) {
+                return obj instanceof $;
+            },
+            toStr: function toStr(s) {
+                return _.isUndefined(s) || s === null ? "" : s + "";
+            },
+            bind: $.proxy,
+            each: function(collection, cb) {
+                $.each(collection, reverseArgs);
+                function reverseArgs(index, value) {
+                    return cb(value, index);
+                }
+            },
+            map: $.map,
+            filter: $.grep,
+            every: function(obj, test) {
+                var result = true;
+                if (!obj) {
+                    return result;
+                }
+                $.each(obj, function(key, val) {
+                    if (!(result = test.call(null, val, key, obj))) {
+                        return false;
+                    }
+                });
+                return !!result;
+            },
+            some: function(obj, test) {
+                var result = false;
+                if (!obj) {
+                    return result;
+                }
+                $.each(obj, function(key, val) {
+                    if (result = test.call(null, val, key, obj)) {
+                        return false;
+                    }
+                });
+                return !!result;
+            },
+            mixin: $.extend,
+            identity: function(x) {
+                return x;
+            },
+            clone: function(obj) {
+                return $.extend(true, {}, obj);
+            },
+            getIdGenerator: function() {
+                var counter = 0;
+                return function() {
+                    return counter++;
+                };
+            },
+            templatify: function templatify(obj) {
+                return $.isFunction(obj) ? obj : template;
+                function template() {
+                    return String(obj);
+                }
+            },
+            defer: function(fn) {
+                setTimeout(fn, 0);
+            },
+            debounce: function(func, wait, immediate) {
+                var timeout, result;
+                return function() {
+                    var context = this, args = arguments, later, callNow;
+                    later = function() {
+                        timeout = null;
+                        if (!immediate) {
+                            result = func.apply(context, args);
+                        }
+                    };
+                    callNow = immediate && !timeout;
+                    clearTimeout(timeout);
+                    timeout = setTimeout(later, wait);
+                    if (callNow) {
+                        result = func.apply(context, args);
+                    }
+                    return result;
+                };
+            },
+            throttle: function(func, wait) {
+                var context, args, timeout, result, previous, later;
+                previous = 0;
+                later = function() {
+                    previous = new Date();
+                    timeout = null;
+                    result = func.apply(context, args);
+                };
+                return function() {
+                    var now = new Date(), remaining = wait - (now - previous);
+                    context = this;
+                    args = arguments;
+                    if (remaining <= 0) {
+                        clearTimeout(timeout);
+                        timeout = null;
+                        previous = now;
+                        result = func.apply(context, args);
+                    } else if (!timeout) {
+                        timeout = setTimeout(later, remaining);
+                    }
+                    return result;
+                };
+            },
+            stringify: function(val) {
+                return _.isString(val) ? val : JSON.stringify(val);
+            },
+            guid: function() {
+                function _p8(s) {
+                    var p = (Math.random().toString(16) + "000000000").substr(2, 8);
+                    return s ? "-" + p.substr(0, 4) + "-" + p.substr(4, 4) : p;
+                }
+                return "tt-" + _p8() + _p8(true) + _p8(true) + _p8();
+            },
+            noop: function() {}
+        };
+    }();
+    var WWW = function() {
+        "use strict";
+        var defaultClassNames = {
+            wrapper: "twitter-typeahead",
+            input: "tt-input",
+            hint: "tt-hint",
+            menu: "tt-menu",
+            dataset: "tt-dataset",
+            suggestion: "tt-suggestion",
+            selectable: "tt-selectable",
+            empty: "tt-empty",
+            open: "tt-open",
+            cursor: "tt-cursor",
+            highlight: "tt-highlight"
+        };
+        return build;
+        function build(o) {
+            var www, classes;
+            classes = _.mixin({}, defaultClassNames, o);
+            www = {
+                css: buildCss(),
+                classes: classes,
+                html: buildHtml(classes),
+                selectors: buildSelectors(classes)
+            };
+            return {
+                css: www.css,
+                html: www.html,
+                classes: www.classes,
+                selectors: www.selectors,
+                mixin: function(o) {
+                    _.mixin(o, www);
+                }
+            };
+        }
+        function buildHtml(c) {
+            return {
+                wrapper: '',
+                menu: '
                                                                                                                                                                                          '
+            };
+        }
+        function buildSelectors(classes) {
+            var selectors = {};
+            _.each(classes, function(v, k) {
+                selectors[k] = "." + v;
+            });
+            return selectors;
+        }
+        function buildCss() {
+            var css = {
+                wrapper: {
+                    position: "relative",
+                    display: "inline-block"
+                },
+                hint: {
+                    position: "absolute",
+                    top: "0",
+                    left: "0",
+                    borderColor: "transparent",
+                    boxShadow: "none",
+                    opacity: "1"
+                },
+                input: {
+                    position: "relative",
+                    verticalAlign: "top",
+                    backgroundColor: "transparent"
+                },
+                inputWithNoHint: {
+                    position: "relative",
+                    verticalAlign: "top"
+                },
+                menu: {
+                    position: "absolute",
+                    top: "100%",
+                    left: "0",
+                    zIndex: "100",
+                    display: "none"
+                },
+                ltr: {
+                    left: "0",
+                    right: "auto"
+                },
+                rtl: {
+                    left: "auto",
+                    right: " 0"
+                }
+            };
+            if (_.isMsie()) {
+                _.mixin(css.input, {
+                    backgroundImage: "url(data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)"
+                });
+            }
+            return css;
+        }
+    }();
+    var EventBus = function() {
+        "use strict";
+        var namespace, deprecationMap;
+        namespace = "typeahead:";
+        deprecationMap = {
+            render: "rendered",
+            cursorchange: "cursorchanged",
+            select: "selected",
+            autocomplete: "autocompleted"
+        };
+        function EventBus(o) {
+            if (!o || !o.el) {
+                $.error("EventBus initialized without el");
+            }
+            this.$el = $(o.el);
+        }
+        _.mixin(EventBus.prototype, {
+            _trigger: function(type, args) {
+                var $e = $.Event(namespace + type);
+                this.$el.trigger.call(this.$el, $e, args || []);
+                return $e;
+            },
+            before: function(type) {
+                var args, $e;
+                args = [].slice.call(arguments, 1);
+                $e = this._trigger("before" + type, args);
+                return $e.isDefaultPrevented();
+            },
+            trigger: function(type) {
+                var deprecatedType;
+                this._trigger(type, [].slice.call(arguments, 1));
+                if (deprecatedType = deprecationMap[type]) {
+                    this._trigger(deprecatedType, [].slice.call(arguments, 1));
+                }
+            }
+        });
+        return EventBus;
+    }();
+    var EventEmitter = function() {
+        "use strict";
+        var splitter = /\s+/, nextTick = getNextTick();
+        return {
+            onSync: onSync,
+            onAsync: onAsync,
+            off: off,
+            trigger: trigger
+        };
+        function on(method, types, cb, context) {
+            var type;
+            if (!cb) {
+                return this;
+            }
+            types = types.split(splitter);
+            cb = context ? bindContext(cb, context) : cb;
+            this._callbacks = this._callbacks || {};
+            while (type = types.shift()) {
+                this._callbacks[type] = this._callbacks[type] || {
+                    sync: [],
+                    async: []
+                };
+                this._callbacks[type][method].push(cb);
+            }
+            return this;
+        }
+        function onAsync(types, cb, context) {
+            return on.call(this, "async", types, cb, context);
+        }
+        function onSync(types, cb, context) {
+            return on.call(this, "sync", types, cb, context);
+        }
+        function off(types) {
+            var type;
+            if (!this._callbacks) {
+                return this;
+            }
+            types = types.split(splitter);
+            while (type = types.shift()) {
+                delete this._callbacks[type];
+            }
+            return this;
+        }
+        function trigger(types) {
+            var type, callbacks, args, syncFlush, asyncFlush;
+            if (!this._callbacks) {
+                return this;
+            }
+            types = types.split(splitter);
+            args = [].slice.call(arguments, 1);
+            while ((type = types.shift()) && (callbacks = this._callbacks[type])) {
+                syncFlush = getFlush(callbacks.sync, this, [ type ].concat(args));
+                asyncFlush = getFlush(callbacks.async, this, [ type ].concat(args));
+                syncFlush() && nextTick(asyncFlush);
+            }
+            return this;
+        }
+        function getFlush(callbacks, context, args) {
+            return flush;
+            function flush() {
+                var cancelled;
+                for (var i = 0, len = callbacks.length; !cancelled && i < len; i += 1) {
+                    cancelled = callbacks[i].apply(context, args) === false;
+                }
+                return !cancelled;
+            }
+        }
+        function getNextTick() {
+            var nextTickFn;
+            if (window.setImmediate) {
+                nextTickFn = function nextTickSetImmediate(fn) {
+                    setImmediate(function() {
+                        fn();
+                    });
+                };
+            } else {
+                nextTickFn = function nextTickSetTimeout(fn) {
+                    setTimeout(function() {
+                        fn();
+                    }, 0);
+                };
+            }
+            return nextTickFn;
+        }
+        function bindContext(fn, context) {
+            return fn.bind ? fn.bind(context) : function() {
+                fn.apply(context, [].slice.call(arguments, 0));
+            };
+        }
+    }();
+    var highlight = function(doc) {
+        "use strict";
+        var defaults = {
+            node: null,
+            pattern: null,
+            tagName: "strong",
+            className: null,
+            wordsOnly: false,
+            caseSensitive: false,
+            diacriticInsensitive: false
+        };
+        var accented = {
+            A: "[AaªÀ-Åà-åĀ-ąǍǎȀ-ȃȦȧᴬᵃḀḁẚẠ-ảₐ℀℁℻⒜Ⓐⓐ㍱-㍴㎀-㎄㎈㎉㎩-㎯㏂㏊㏟㏿Ａａ]",
+            B: "[BbᴮᵇḂ-ḇℬ⒝Ⓑⓑ㍴㎅-㎇㏃㏈㏔㏝Ｂｂ]",
+            C: "[CcÇçĆ-čᶜ℀ℂ℃℅℆ℭⅭⅽ⒞Ⓒⓒ㍶㎈㎉㎝㎠㎤㏄-㏇Ｃｃ]",
+            D: "[DdĎďDŽ-džDZ-dzᴰᵈḊ-ḓⅅⅆⅮⅾ⒟Ⓓⓓ㋏㍲㍷-㍹㎗㎭-㎯㏅㏈Ｄｄ]",
+            E: "[EeÈ-Ëè-ëĒ-ěȄ-ȇȨȩᴱᵉḘ-ḛẸ-ẽₑ℡ℯℰⅇ⒠Ⓔⓔ㉐㋍㋎Ｅｅ]",
+            F: "[FfᶠḞḟ℉ℱ℻⒡Ⓕⓕ㎊-㎌㎙ff-fflＦｆ]",
+            G: "[GgĜ-ģǦǧǴǵᴳᵍḠḡℊ⒢Ⓖⓖ㋌㋍㎇㎍-㎏㎓㎬㏆㏉㏒㏿Ｇｇ]",
+            H: "[HhĤĥȞȟʰᴴḢ-ḫẖℋ-ℎ⒣Ⓗⓗ㋌㍱㎐-㎔㏊㏋㏗Ｈｈ]",
+            I: "[IiÌ-Ïì-ïĨ-İIJijǏǐȈ-ȋᴵᵢḬḭỈ-ịⁱℐℑℹⅈⅠ-ⅣⅥ-ⅨⅪⅫⅰ-ⅳⅵ-ⅸⅺⅻ⒤Ⓘⓘ㍺㏌㏕fiffiＩｉ]",
+            J: "[JjIJ-ĵLJ-njǰʲᴶⅉ⒥ⒿⓙⱼＪｊ]",
+            K: "[KkĶķǨǩᴷᵏḰ-ḵK⒦Ⓚⓚ㎄㎅㎉㎏㎑㎘㎞㎢㎦㎪㎸㎾㏀㏆㏍-㏏Ｋｋ]",
+            L: "[LlĹ-ŀLJ-ljˡᴸḶḷḺ-ḽℒℓ℡Ⅼⅼ⒧Ⓛⓛ㋏㎈㎉㏐-㏓㏕㏖㏿flfflＬｌ]",
+            M: "[MmᴹᵐḾ-ṃ℠™ℳⅯⅿ⒨Ⓜⓜ㍷-㍹㎃㎆㎎㎒㎖㎙-㎨㎫㎳㎷㎹㎽㎿㏁㏂㏎㏐㏔-㏖㏘㏙㏞㏟Ｍｍ]",
+            N: "[NnÑñŃ-ʼnNJ-njǸǹᴺṄ-ṋⁿℕ№⒩Ⓝⓝ㎁㎋㎚㎱㎵㎻㏌㏑Ｎｎ]",
+            O: "[OoºÒ-Öò-öŌ-őƠơǑǒǪǫȌ-ȏȮȯᴼᵒỌ-ỏₒ℅№ℴ⒪Ⓞⓞ㍵㏇㏒㏖Ｏｏ]",
+            P: "[PpᴾᵖṔ-ṗℙ⒫Ⓟⓟ㉐㍱㍶㎀㎊㎩-㎬㎰㎴㎺㏋㏗-㏚Ｐｐ]",
+            Q: "[Qqℚ⒬Ⓠⓠ㏃Ｑｑ]",
+            R: "[RrŔ-řȐ-ȓʳᴿᵣṘ-ṛṞṟ₨ℛ-ℝ⒭Ⓡⓡ㋍㍴㎭-㎯㏚㏛Ｒｒ]",
+            S: "[SsŚ-šſȘșˢṠ-ṣ₨℁℠⒮Ⓢⓢ㎧㎨㎮-㎳㏛㏜stＳｓ]",
+            T: "[TtŢ-ťȚțᵀᵗṪ-ṱẗ℡™⒯Ⓣⓣ㉐㋏㎔㏏ſtstＴｔ]",
+            U: "[UuÙ-Üù-üŨ-ųƯưǓǔȔ-ȗᵁᵘᵤṲ-ṷỤ-ủ℆⒰Ⓤⓤ㍳㍺Ｕｕ]",
+            V: "[VvᵛᵥṼ-ṿⅣ-Ⅷⅳ-ⅷ⒱Ⓥⓥⱽ㋎㍵㎴-㎹㏜㏞Ｖｖ]",
+            W: "[WwŴŵʷᵂẀ-ẉẘ⒲Ⓦⓦ㎺-㎿㏝Ｗｗ]",
+            X: "[XxˣẊ-ẍₓ℻Ⅸ-Ⅻⅸ-ⅻ⒳Ⓧⓧ㏓Ｘｘ]",
+            Y: "[YyÝýÿŶ-ŸȲȳʸẎẏẙỲ-ỹ⒴Ⓨⓨ㏉Ｙｙ]",
+            Z: "[ZzŹ-žDZ-dzᶻẐ-ẕℤℨ⒵Ⓩⓩ㎐-㎔Ｚｚ]"
+        };
+        return function hightlight(o) {
+            var regex;
+            o = _.mixin({}, defaults, o);
+            if (!o.node || !o.pattern) {
+                return;
+            }
+            o.pattern = _.isArray(o.pattern) ? o.pattern : [ o.pattern ];
+            regex = getRegex(o.pattern, o.caseSensitive, o.wordsOnly, o.diacriticInsensitive);
+            traverse(o.node, hightlightTextNode);
+            function hightlightTextNode(textNode) {
+                var match, patternNode, wrapperNode;
+                if (match = regex.exec(textNode.data)) {
+                    wrapperNode = doc.createElement(o.tagName);
+                    o.className && (wrapperNode.className = o.className);
+                    patternNode = textNode.splitText(match.index);
+                    patternNode.splitText(match[0].length);
+                    wrapperNode.appendChild(patternNode.cloneNode(true));
+                    textNode.parentNode.replaceChild(wrapperNode, patternNode);
+                }
+                return !!match;
+            }
+            function traverse(el, hightlightTextNode) {
+                var childNode, TEXT_NODE_TYPE = 3;
+                for (var i = 0; i < el.childNodes.length; i++) {
+                    childNode = el.childNodes[i];
+                    if (childNode.nodeType === TEXT_NODE_TYPE) {
+                        i += hightlightTextNode(childNode) ? 1 : 0;
+                    } else {
+                        traverse(childNode, hightlightTextNode);
+                    }
+                }
+            }
+        };
+        function accent_replacer(chr) {
+            return accented[chr.toUpperCase()] || chr;
+        }
+        function getRegex(patterns, caseSensitive, wordsOnly, diacriticInsensitive) {
+            var escapedPatterns = [], regexStr;
+            for (var i = 0, len = patterns.length; i < len; i++) {
+                var escapedWord = _.escapeRegExChars(patterns[i]);
+                if (diacriticInsensitive) {
+                    escapedWord = escapedWord.replace(/\S/g, accent_replacer);
+                }
+                escapedPatterns.push(escapedWord);
+            }
+            regexStr = wordsOnly ? "\\b(" + escapedPatterns.join("|") + ")\\b" : "(" + escapedPatterns.join("|") + ")";
+            return caseSensitive ? new RegExp(regexStr) : new RegExp(regexStr, "i");
+        }
+    }(window.document);
+    var Input = function() {
+        "use strict";
+        var specialKeyCodeMap;
+        specialKeyCodeMap = {
+            9: "tab",
+            27: "esc",
+            37: "left",
+            39: "right",
+            13: "enter",
+            38: "up",
+            40: "down"
+        };
+        function Input(o, www) {
+            var id;
+            o = o || {};
+            if (!o.input) {
+                $.error("input is missing");
+            }
+            www.mixin(this);
+            this.$hint = $(o.hint);
+            this.$input = $(o.input);
+            this.$menu = $(o.menu);
+            id = this.$input.attr("id") || _.guid();
+            this.$menu.attr("id", id + "_listbox");
+            this.$hint.attr({
+                "aria-hidden": true
+            });
+            this.$input.attr({
+                "aria-owns": id + "_listbox",
+                role: "combobox",
+                "aria-autocomplete": "list",
+                "aria-expanded": false
+            });
+            this.query = this.$input.val();
+            this.queryWhenFocused = this.hasFocus() ? this.query : null;
+            this.$overflowHelper = buildOverflowHelper(this.$input);
+            this._checkLanguageDirection();
+            if (this.$hint.length === 0) {
+                this.setHint = this.getHint = this.clearHint = this.clearHintIfInvalid = _.noop;
+            }
+            this.onSync("cursorchange", this._updateDescendent);
+        }
+        Input.normalizeQuery = function(str) {
+            return _.toStr(str).replace(/^\s*/g, "").replace(/\s{2,}/g, " ");
+        };
+        _.mixin(Input.prototype, EventEmitter, {
+            _onBlur: function onBlur() {
+                this.resetInputValue();
+                this.trigger("blurred");
+            },
+            _onFocus: function onFocus() {
+                this.queryWhenFocused = this.query;
+                this.trigger("focused");
+            },
+            _onKeydown: function onKeydown($e) {
+                var keyName = specialKeyCodeMap[$e.which || $e.keyCode];
+                this._managePreventDefault(keyName, $e);
+                if (keyName && this._shouldTrigger(keyName, $e)) {
+                    this.trigger(keyName + "Keyed", $e);
+                }
+            },
+            _onInput: function onInput() {
+                this._setQuery(this.getInputValue());
+                this.clearHintIfInvalid();
+                this._checkLanguageDirection();
+            },
+            _managePreventDefault: function managePreventDefault(keyName, $e) {
+                var preventDefault;
+                switch (keyName) {
+                  case "up":
+                  case "down":
+                    preventDefault = !withModifier($e);
+                    break;
+
+                  default:
+                    preventDefault = false;
+                }
+                preventDefault && $e.preventDefault();
+            },
+            _shouldTrigger: function shouldTrigger(keyName, $e) {
+                var trigger;
+                switch (keyName) {
+                  case "tab":
+                    trigger = !withModifier($e);
+                    break;
+
+                  default:
+                    trigger = true;
+                }
+                return trigger;
+            },
+            _checkLanguageDirection: function checkLanguageDirection() {
+                var dir = (this.$input.css("direction") || "ltr").toLowerCase();
+                if (this.dir !== dir) {
+                    this.dir = dir;
+                    this.$hint.attr("dir", dir);
+                    this.trigger("langDirChanged", dir);
+                }
+            },
+            _setQuery: function setQuery(val, silent) {
+                var areEquivalent, hasDifferentWhitespace;
+                areEquivalent = areQueriesEquivalent(val, this.query);
+                hasDifferentWhitespace = areEquivalent ? this.query.length !== val.length : false;
+                this.query = val;
+                if (!silent && !areEquivalent) {
+                    this.trigger("queryChanged", this.query);
+                } else if (!silent && hasDifferentWhitespace) {
+                    this.trigger("whitespaceChanged", this.query);
+                }
+            },
+            _updateDescendent: function updateDescendent(event, id) {
+                this.$input.attr("aria-activedescendant", id);
+            },
+            bind: function() {
+                var that = this, onBlur, onFocus, onKeydown, onInput;
+                onBlur = _.bind(this._onBlur, this);
+                onFocus = _.bind(this._onFocus, this);
+                onKeydown = _.bind(this._onKeydown, this);
+                onInput = _.bind(this._onInput, this);
+                this.$input.on("blur.tt", onBlur).on("focus.tt", onFocus).on("keydown.tt", onKeydown);
+                if (!_.isMsie() || _.isMsie() > 9) {
+                    this.$input.on("input.tt", onInput);
+                } else {
+                    this.$input.on("keydown.tt keypress.tt cut.tt paste.tt", function($e) {
+                        if (specialKeyCodeMap[$e.which || $e.keyCode]) {
+                            return;
+                        }
+                        _.defer(_.bind(that._onInput, that, $e));
+                    });
+                }
+                return this;
+            },
+            focus: function focus() {
+                this.$input.focus();
+            },
+            blur: function blur() {
+                this.$input.blur();
+            },
+            getLangDir: function getLangDir() {
+                return this.dir;
+            },
+            getQuery: function getQuery() {
+                return this.query || "";
+            },
+            setQuery: function setQuery(val, silent) {
+                this.setInputValue(val);
+                this._setQuery(val, silent);
+            },
+            hasQueryChangedSinceLastFocus: function hasQueryChangedSinceLastFocus() {
+                return this.query !== this.queryWhenFocused;
+            },
+            getInputValue: function getInputValue() {
+                return this.$input.val();
+            },
+            setInputValue: function setInputValue(value) {
+                this.$input.val(value);
+                this.clearHintIfInvalid();
+                this._checkLanguageDirection();
+            },
+            resetInputValue: function resetInputValue() {
+                this.setInputValue(this.query);
+            },
+            getHint: function getHint() {
+                return this.$hint.val();
+            },
+            setHint: function setHint(value) {
+                this.$hint.val(value);
+            },
+            clearHint: function clearHint() {
+                this.setHint("");
+            },
+            clearHintIfInvalid: function clearHintIfInvalid() {
+                var val, hint, valIsPrefixOfHint, isValid;
+                val = this.getInputValue();
+                hint = this.getHint();
+                valIsPrefixOfHint = val !== hint && hint.indexOf(val) === 0;
+                isValid = val !== "" && valIsPrefixOfHint && !this.hasOverflow();
+                !isValid && this.clearHint();
+            },
+            hasFocus: function hasFocus() {
+                return this.$input.is(":focus");
+            },
+            hasOverflow: function hasOverflow() {
+                var constraint = this.$input.width() - 2;
+                this.$overflowHelper.text(this.getInputValue());
+                return this.$overflowHelper.width() >= constraint;
+            },
+            isCursorAtEnd: function() {
+                var valueLength, selectionStart, range;
+                valueLength = this.$input.val().length;
+                selectionStart = this.$input[0].selectionStart;
+                if (_.isNumber(selectionStart)) {
+                    return selectionStart === valueLength;
+                } else if (document.selection) {
+                    range = document.selection.createRange();
+                    range.moveStart("character", -valueLength);
+                    return valueLength === range.text.length;
+                }
+                return true;
+            },
+            destroy: function destroy() {
+                this.$hint.off(".tt");
+                this.$input.off(".tt");
+                this.$overflowHelper.remove();
+                this.$hint = this.$input = this.$overflowHelper = $("
                                                                                                                                                                                          ");
+            },
+            setAriaExpanded: function setAriaExpanded(value) {
+                this.$input.attr("aria-expanded", value);
+            }
+        });
+        return Input;
+        function buildOverflowHelper($input) {
+            return $('').css({
+                position: "absolute",
+                visibility: "hidden",
+                whiteSpace: "pre",
+                fontFamily: $input.css("font-family"),
+                fontSize: $input.css("font-size"),
+                fontStyle: $input.css("font-style"),
+                fontVariant: $input.css("font-variant"),
+                fontWeight: $input.css("font-weight"),
+                wordSpacing: $input.css("word-spacing"),
+                letterSpacing: $input.css("letter-spacing"),
+                textIndent: $input.css("text-indent"),
+                textRendering: $input.css("text-rendering"),
+                textTransform: $input.css("text-transform")
+            }).insertAfter($input);
+        }
+        function areQueriesEquivalent(a, b) {
+            return Input.normalizeQuery(a) === Input.normalizeQuery(b);
+        }
+        function withModifier($e) {
+            return $e.altKey || $e.ctrlKey || $e.metaKey || $e.shiftKey;
+        }
+    }();
+    var Dataset = function() {
+        "use strict";
+        var keys, nameGenerator;
+        keys = {
+            dataset: "tt-selectable-dataset",
+            val: "tt-selectable-display",
+            obj: "tt-selectable-object"
+        };
+        nameGenerator = _.getIdGenerator();
+        function Dataset(o, www) {
+            o = o || {};
+            o.templates = o.templates || {};
+            o.templates.notFound = o.templates.notFound || o.templates.empty;
+            if (!o.source) {
+                $.error("missing source");
+            }
+            if (!o.node) {
+                $.error("missing node");
+            }
+            if (o.name && !isValidName(o.name)) {
+                $.error("invalid dataset name: " + o.name);
+            }
+            www.mixin(this);
+            this.highlight = !!o.highlight;
+            this.name = _.toStr(o.name || nameGenerator());
+            this.limit = o.limit || 5;
+            this.displayFn = getDisplayFn(o.display || o.displayKey);
+            this.templates = getTemplates(o.templates, this.displayFn);
+            this.source = o.source.__ttAdapter ? o.source.__ttAdapter() : o.source;
+            this.async = _.isUndefined(o.async) ? this.source.length > 2 : !!o.async;
+            this._resetLastSuggestion();
+            this.$el = $(o.node).attr("role", "presentation").addClass(this.classes.dataset).addClass(this.classes.dataset + "-" + this.name);
+        }
+        Dataset.extractData = function extractData(el) {
+            var $el = $(el);
+            if ($el.data(keys.obj)) {
+                return {
+                    dataset: $el.data(keys.dataset) || "",
+                    val: $el.data(keys.val) || "",
+                    obj: $el.data(keys.obj) || null
+                };
+            }
+            return null;
+        };
+        _.mixin(Dataset.prototype, EventEmitter, {
+            _overwrite: function overwrite(query, suggestions) {
+                suggestions = suggestions || [];
+                if (suggestions.length) {
+                    this._renderSuggestions(query, suggestions);
+                } else if (this.async && this.templates.pending) {
+                    this._renderPending(query);
+                } else if (!this.async && this.templates.notFound) {
+                    this._renderNotFound(query);
+                } else {
+                    this._empty();
+                }
+                this.trigger("rendered", suggestions, false, this.name);
+            },
+            _append: function append(query, suggestions) {
+                suggestions = suggestions || [];
+                if (suggestions.length && this.$lastSuggestion.length) {
+                    this._appendSuggestions(query, suggestions);
+                } else if (suggestions.length) {
+                    this._renderSuggestions(query, suggestions);
+                } else if (!this.$lastSuggestion.length && this.templates.notFound) {
+                    this._renderNotFound(query);
+                }
+                this.trigger("rendered", suggestions, true, this.name);
+            },
+            _renderSuggestions: function renderSuggestions(query, suggestions) {
+                var $fragment;
+                $fragment = this._getSuggestionsFragment(query, suggestions);
+                this.$lastSuggestion = $fragment.children().last();
+                this.$el.html($fragment).prepend(this._getHeader(query, suggestions)).append(this._getFooter(query, suggestions));
+            },
+            _appendSuggestions: function appendSuggestions(query, suggestions) {
+                var $fragment, $lastSuggestion;
+                $fragment = this._getSuggestionsFragment(query, suggestions);
+                $lastSuggestion = $fragment.children().last();
+                this.$lastSuggestion.after($fragment);
+                this.$lastSuggestion = $lastSuggestion;
+            },
+            _renderPending: function renderPending(query) {
+                var template = this.templates.pending;
+                this._resetLastSuggestion();
+                template && this.$el.html(template({
+                    query: query,
+                    dataset: this.name
+                }));
+            },
+            _renderNotFound: function renderNotFound(query) {
+                var template = this.templates.notFound;
+                this._resetLastSuggestion();
+                template && this.$el.html(template({
+                    query: query,
+                    dataset: this.name
+                }));
+            },
+            _empty: function empty() {
+                this.$el.empty();
+                this._resetLastSuggestion();
+            },
+            _getSuggestionsFragment: function getSuggestionsFragment(query, suggestions) {
+                var that = this, fragment;
+                fragment = document.createDocumentFragment();
+                _.each(suggestions, function getSuggestionNode(suggestion) {
+                    var $el, context;
+                    context = that._injectQuery(query, suggestion);
+                    $el = $(that.templates.suggestion(context)).data(keys.dataset, that.name).data(keys.obj, suggestion).data(keys.val, that.displayFn(suggestion)).addClass(that.classes.suggestion + " " + that.classes.selectable);
+                    fragment.appendChild($el[0]);
+                });
+                this.highlight && highlight({
+                    className: this.classes.highlight,
+                    node: fragment,
+                    pattern: query
+                });
+                return $(fragment);
+            },
+            _getFooter: function getFooter(query, suggestions) {
+                return this.templates.footer ? this.templates.footer({
+                    query: query,
+                    suggestions: suggestions,
+                    dataset: this.name
+                }) : null;
+            },
+            _getHeader: function getHeader(query, suggestions) {
+                return this.templates.header ? this.templates.header({
+                    query: query,
+                    suggestions: suggestions,
+                    dataset: this.name
+                }) : null;
+            },
+            _resetLastSuggestion: function resetLastSuggestion() {
+                this.$lastSuggestion = $();
+            },
+            _injectQuery: function injectQuery(query, obj) {
+                return _.isObject(obj) ? _.mixin({
+                    _query: query
+                }, obj) : obj;
+            },
+            update: function update(query) {
+                var that = this, canceled = false, syncCalled = false, rendered = 0;
+                this.cancel();
+                this.cancel = function cancel() {
+                    canceled = true;
+                    that.cancel = $.noop;
+                    that.async && that.trigger("asyncCanceled", query, that.name);
+                };
+                this.source(query, sync, async);
+                !syncCalled && sync([]);
+                function sync(suggestions) {
+                    if (syncCalled) {
+                        return;
+                    }
+                    syncCalled = true;
+                    suggestions = (suggestions || []).slice(0, that.limit);
+                    rendered = suggestions.length;
+                    that._overwrite(query, suggestions);
+                    if (rendered < that.limit && that.async) {
+                        that.trigger("asyncRequested", query, that.name);
+                    }
+                }
+                function async(suggestions) {
+                    suggestions = suggestions || [];
+                    if (!canceled && rendered < that.limit) {
+                        that.cancel = $.noop;
+                        var idx = Math.abs(rendered - that.limit);
+                        rendered += idx;
+                        that._append(query, suggestions.slice(0, idx));
+                        that.async && that.trigger("asyncReceived", query, that.name);
+                    }
+                }
+            },
+            cancel: $.noop,
+            clear: function clear() {
+                this._empty();
+                this.cancel();
+                this.trigger("cleared");
+            },
+            isEmpty: function isEmpty() {
+                return this.$el.is(":empty");
+            },
+            destroy: function destroy() {
+                this.$el = $("
                                                                                                                                                                                          ");
+            }
+        });
+        return Dataset;
+        function getDisplayFn(display) {
+            display = display || _.stringify;
+            return _.isFunction(display) ? display : displayFn;
+            function displayFn(obj) {
+                return obj[display];
+            }
+        }
+        function getTemplates(templates, displayFn) {
+            return {
+                notFound: templates.notFound && _.templatify(templates.notFound),
+                pending: templates.pending && _.templatify(templates.pending),
+                header: templates.header && _.templatify(templates.header),
+                footer: templates.footer && _.templatify(templates.footer),
+                suggestion: templates.suggestion ? userSuggestionTemplate : suggestionTemplate
+            };
+            function userSuggestionTemplate(context) {
+                var template = templates.suggestion;
+                return $(template(context)).attr("id", _.guid());
+            }
+            function suggestionTemplate(context) {
+                return $('
                                                                                                                                                                                          ').attr("id", _.guid()).text(displayFn(context));
+            }
+        }
+        function isValidName(str) {
+            return /^[_a-zA-Z0-9-]+$/.test(str);
+        }
+    }();
+    var Menu = function() {
+        "use strict";
+        function Menu(o, www) {
+            var that = this;
+            o = o || {};
+            if (!o.node) {
+                $.error("node is required");
+            }
+            www.mixin(this);
+            this.$node = $(o.node);
+            this.query = null;
+            this.datasets = _.map(o.datasets, initializeDataset);
+            function initializeDataset(oDataset) {
+                var node = that.$node.find(oDataset.node).first();
+                oDataset.node = node.length ? node : $("
                                                                                                                                                                                          ").appendTo(that.$node);
+                return new Dataset(oDataset, www);
+            }
+        }
+        _.mixin(Menu.prototype, EventEmitter, {
+            _onSelectableClick: function onSelectableClick($e) {
+                this.trigger("selectableClicked", $($e.currentTarget));
+            },
+            _onRendered: function onRendered(type, dataset, suggestions, async) {
+                this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty());
+                this.trigger("datasetRendered", dataset, suggestions, async);
+            },
+            _onCleared: function onCleared() {
+                this.$node.toggleClass(this.classes.empty, this._allDatasetsEmpty());
+                this.trigger("datasetCleared");
+            },
+            _propagate: function propagate() {
+                this.trigger.apply(this, arguments);
+            },
+            _allDatasetsEmpty: function allDatasetsEmpty() {
+                return _.every(this.datasets, _.bind(function isDatasetEmpty(dataset) {
+                    var isEmpty = dataset.isEmpty();
+                    this.$node.attr("aria-expanded", !isEmpty);
+                    return isEmpty;
+                }, this));
+            },
+            _getSelectables: function getSelectables() {
+                return this.$node.find(this.selectors.selectable);
+            },
+            _removeCursor: function _removeCursor() {
+                var $selectable = this.getActiveSelectable();
+                $selectable && $selectable.removeClass(this.classes.cursor);
+            },
+            _ensureVisible: function ensureVisible($el) {
+                var elTop, elBottom, nodeScrollTop, nodeHeight;
+                elTop = $el.position().top;
+                elBottom = elTop + $el.outerHeight(true);
+                nodeScrollTop = this.$node.scrollTop();
+                nodeHeight = this.$node.height() + parseInt(this.$node.css("paddingTop"), 10) + parseInt(this.$node.css("paddingBottom"), 10);
+                if (elTop < 0) {
+                    this.$node.scrollTop(nodeScrollTop + elTop);
+                } else if (nodeHeight < elBottom) {
+                    this.$node.scrollTop(nodeScrollTop + (elBottom - nodeHeight));
+                }
+            },
+            bind: function() {
+                var that = this, onSelectableClick;
+                onSelectableClick = _.bind(this._onSelectableClick, this);
+                this.$node.on("click.tt", this.selectors.selectable, onSelectableClick);
+                this.$node.on("mouseover", this.selectors.selectable, function() {
+                    that.setCursor($(this));
+                });
+                this.$node.on("mouseleave", function() {
+                    that._removeCursor();
+                });
+                _.each(this.datasets, function(dataset) {
+                    dataset.onSync("asyncRequested", that._propagate, that).onSync("asyncCanceled", that._propagate, that).onSync("asyncReceived", that._propagate, that).onSync("rendered", that._onRendered, that).onSync("cleared", that._onCleared, that);
+                });
+                return this;
+            },
+            isOpen: function isOpen() {
+                return this.$node.hasClass(this.classes.open);
+            },
+            open: function open() {
+                this.$node.scrollTop(0);
+                this.$node.addClass(this.classes.open);
+            },
+            close: function close() {
+                this.$node.attr("aria-expanded", false);
+                this.$node.removeClass(this.classes.open);
+                this._removeCursor();
+            },
+            setLanguageDirection: function setLanguageDirection(dir) {
+                this.$node.attr("dir", dir);
+            },
+            selectableRelativeToCursor: function selectableRelativeToCursor(delta) {
+                var $selectables, $oldCursor, oldIndex, newIndex;
+                $oldCursor = this.getActiveSelectable();
+                $selectables = this._getSelectables();
+                oldIndex = $oldCursor ? $selectables.index($oldCursor) : -1;
+                newIndex = oldIndex + delta;
+                newIndex = (newIndex + 1) % ($selectables.length + 1) - 1;
+                newIndex = newIndex < -1 ? $selectables.length - 1 : newIndex;
+                return newIndex === -1 ? null : $selectables.eq(newIndex);
+            },
+            setCursor: function setCursor($selectable) {
+                this._removeCursor();
+                if ($selectable = $selectable && $selectable.first()) {
+                    $selectable.addClass(this.classes.cursor);
+                    this._ensureVisible($selectable);
+                }
+            },
+            getSelectableData: function getSelectableData($el) {
+                return $el && $el.length ? Dataset.extractData($el) : null;
+            },
+            getActiveSelectable: function getActiveSelectable() {
+                var $selectable = this._getSelectables().filter(this.selectors.cursor).first();
+                return $selectable.length ? $selectable : null;
+            },
+            getTopSelectable: function getTopSelectable() {
+                var $selectable = this._getSelectables().first();
+                return $selectable.length ? $selectable : null;
+            },
+            update: function update(query) {
+                var isValidUpdate = query !== this.query;
+                if (isValidUpdate) {
+                    this.query = query;
+                    _.each(this.datasets, updateDataset);
+                }
+                return isValidUpdate;
+                function updateDataset(dataset) {
+                    dataset.update(query);
+                }
+            },
+            empty: function empty() {
+                _.each(this.datasets, clearDataset);
+                this.query = null;
+                this.$node.addClass(this.classes.empty);
+                function clearDataset(dataset) {
+                    dataset.clear();
+                }
+            },
+            destroy: function destroy() {
+                this.$node.off(".tt");
+                this.$node = $("
                                                                                                                                                                                          ");
+                _.each(this.datasets, destroyDataset);
+                function destroyDataset(dataset) {
+                    dataset.destroy();
+                }
+            }
+        });
+        return Menu;
+    }();
+    var Status = function() {
+        "use strict";
+        function Status(options) {
+            this.$el = $("", {
+                role: "status",
+                "aria-live": "polite"
+            }).css({
+                position: "absolute",
+                padding: "0",
+                border: "0",
+                height: "1px",
+                width: "1px",
+                "margin-bottom": "-1px",
+                "margin-right": "-1px",
+                overflow: "hidden",
+                clip: "rect(0 0 0 0)",
+                "white-space": "nowrap"
+            });
+            options.$input.after(this.$el);
+            _.each(options.menu.datasets, _.bind(function(dataset) {
+                if (dataset.onSync) {
+                    dataset.onSync("rendered", _.bind(this.update, this));
+                    dataset.onSync("cleared", _.bind(this.cleared, this));
+                }
+            }, this));
+        }
+        _.mixin(Status.prototype, {
+            update: function update(event, suggestions) {
+                var length = suggestions.length;
+                var words;
+                if (length === 1) {
+                    words = {
+                        result: "result",
+                        is: "is"
+                    };
+                } else {
+                    words = {
+                        result: "results",
+                        is: "are"
+                    };
+                }
+                this.$el.text(length + " " + words.result + " " + words.is + " available, use up and down arrow keys to navigate.");
+            },
+            cleared: function() {
+                this.$el.text("");
+            }
+        });
+        return Status;
+    }();
+    var DefaultMenu = function() {
+        "use strict";
+        var s = Menu.prototype;
+        function DefaultMenu() {
+            Menu.apply(this, [].slice.call(arguments, 0));
+        }
+        _.mixin(DefaultMenu.prototype, Menu.prototype, {
+            open: function open() {
+                !this._allDatasetsEmpty() && this._show();
+                return s.open.apply(this, [].slice.call(arguments, 0));
+            },
+            close: function close() {
+                this._hide();
+                return s.close.apply(this, [].slice.call(arguments, 0));
+            },
+            _onRendered: function onRendered() {
+                if (this._allDatasetsEmpty()) {
+                    this._hide();
+                } else {
+                    this.isOpen() && this._show();
+                }
+                return s._onRendered.apply(this, [].slice.call(arguments, 0));
+            },
+            _onCleared: function onCleared() {
+                if (this._allDatasetsEmpty()) {
+                    this._hide();
+                } else {
+                    this.isOpen() && this._show();
+                }
+                return s._onCleared.apply(this, [].slice.call(arguments, 0));
+            },
+            setLanguageDirection: function setLanguageDirection(dir) {
+                this.$node.css(dir === "ltr" ? this.css.ltr : this.css.rtl);
+                return s.setLanguageDirection.apply(this, [].slice.call(arguments, 0));
+            },
+            _hide: function hide() {
+                this.$node.hide();
+            },
+            _show: function show() {
+                this.$node.css("display", "block");
+            }
+        });
+        return DefaultMenu;
+    }();
+    var Typeahead = function() {
+        "use strict";
+        function Typeahead(o, www) {
+            var onFocused, onBlurred, onEnterKeyed, onTabKeyed, onEscKeyed, onUpKeyed, onDownKeyed, onLeftKeyed, onRightKeyed, onQueryChanged, onWhitespaceChanged;
+            o = o || {};
+            if (!o.input) {
+                $.error("missing input");
+            }
+            if (!o.menu) {
+                $.error("missing menu");
+            }
+            if (!o.eventBus) {
+                $.error("missing event bus");
+            }
+            www.mixin(this);
+            this.eventBus = o.eventBus;
+            this.minLength = _.isNumber(o.minLength) ? o.minLength : 1;
+            this.input = o.input;
+            this.menu = o.menu;
+            this.enabled = true;
+            this.autoselect = !!o.autoselect;
+            this.active = false;
+            this.input.hasFocus() && this.activate();
+            this.dir = this.input.getLangDir();
+            this._hacks();
+            this.menu.bind().onSync("selectableClicked", this._onSelectableClicked, this).onSync("asyncRequested", this._onAsyncRequested, this).onSync("asyncCanceled", this._onAsyncCanceled, this).onSync("asyncReceived", this._onAsyncReceived, this).onSync("datasetRendered", this._onDatasetRendered, this).onSync("datasetCleared", this._onDatasetCleared, this);
+            onFocused = c(this, "activate", "open", "_onFocused");
+            onBlurred = c(this, "deactivate", "_onBlurred");
+            onEnterKeyed = c(this, "isActive", "isOpen", "_onEnterKeyed");
+            onTabKeyed = c(this, "isActive", "isOpen", "_onTabKeyed");
+            onEscKeyed = c(this, "isActive", "_onEscKeyed");
+            onUpKeyed = c(this, "isActive", "open", "_onUpKeyed");
+            onDownKeyed = c(this, "isActive", "open", "_onDownKeyed");
+            onLeftKeyed = c(this, "isActive", "isOpen", "_onLeftKeyed");
+            onRightKeyed = c(this, "isActive", "isOpen", "_onRightKeyed");
+            onQueryChanged = c(this, "_openIfActive", "_onQueryChanged");
+            onWhitespaceChanged = c(this, "_openIfActive", "_onWhitespaceChanged");
+            this.input.bind().onSync("focused", onFocused, this).onSync("blurred", onBlurred, this).onSync("enterKeyed", onEnterKeyed, this).onSync("tabKeyed", onTabKeyed, this).onSync("escKeyed", onEscKeyed, this).onSync("upKeyed", onUpKeyed, this).onSync("downKeyed", onDownKeyed, this).onSync("leftKeyed", onLeftKeyed, this).onSync("rightKeyed", onRightKeyed, this).onSync("queryChanged", onQueryChanged, this).onSync("whitespaceChanged", onWhitespaceChanged, this).onSync("langDirChanged", this._onLangDirChanged, this);
+        }
+        _.mixin(Typeahead.prototype, {
+            _hacks: function hacks() {
+                var $input, $menu;
+                $input = this.input.$input || $("
                                                                                                                                                                                          ");
+                $menu = this.menu.$node || $("
                                                                                                                                                                                          ");
+                $input.on("blur.tt", function($e) {
+                    var active, isActive, hasActive;
+                    active = document.activeElement;
+                    isActive = $menu.is(active);
+                    hasActive = $menu.has(active).length > 0;
+                    if (_.isMsie() && (isActive || hasActive)) {
+                        $e.preventDefault();
+                        $e.stopImmediatePropagation();
+                        _.defer(function() {
+                            $input.focus();
+                        });
+                    }
+                });
+                $menu.on("mousedown.tt", function($e) {
+                    $e.preventDefault();
+                });
+            },
+            _onSelectableClicked: function onSelectableClicked(type, $el) {
+                this.select($el);
+            },
+            _onDatasetCleared: function onDatasetCleared() {
+                this._updateHint();
+            },
+            _onDatasetRendered: function onDatasetRendered(type, suggestions, async, dataset) {
+                this._updateHint();
+                if (this.autoselect) {
+                    var cursorClass = this.selectors.cursor.substr(1);
+                    this.menu.$node.find(this.selectors.suggestion).first().addClass(cursorClass);
+                }
+                this.eventBus.trigger("render", suggestions, async, dataset);
+            },
+            _onAsyncRequested: function onAsyncRequested(type, dataset, query) {
+                this.eventBus.trigger("asyncrequest", query, dataset);
+            },
+            _onAsyncCanceled: function onAsyncCanceled(type, dataset, query) {
+                this.eventBus.trigger("asynccancel", query, dataset);
+            },
+            _onAsyncReceived: function onAsyncReceived(type, dataset, query) {
+                this.eventBus.trigger("asyncreceive", query, dataset);
+            },
+            _onFocused: function onFocused() {
+                this._minLengthMet() && this.menu.update(this.input.getQuery());
+            },
+            _onBlurred: function onBlurred() {
+                if (this.input.hasQueryChangedSinceLastFocus()) {
+                    this.eventBus.trigger("change", this.input.getQuery());
+                }
+            },
+            _onEnterKeyed: function onEnterKeyed(type, $e) {
+                var $selectable;
+                if ($selectable = this.menu.getActiveSelectable()) {
+                    if (this.select($selectable)) {
+                        $e.preventDefault();
+                        $e.stopPropagation();
+                    }
+                } else if (this.autoselect) {
+                    if (this.select(this.menu.getTopSelectable())) {
+                        $e.preventDefault();
+                        $e.stopPropagation();
+                    }
+                }
+            },
+            _onTabKeyed: function onTabKeyed(type, $e) {
+                var $selectable;
+                if ($selectable = this.menu.getActiveSelectable()) {
+                    this.select($selectable) && $e.preventDefault();
+                } else if (this.autoselect) {
+                    if ($selectable = this.menu.getTopSelectable()) {
+                        this.autocomplete($selectable) && $e.preventDefault();
+                    }
+                }
+            },
+            _onEscKeyed: function onEscKeyed() {
+                this.close();
+            },
+            _onUpKeyed: function onUpKeyed() {
+                this.moveCursor(-1);
+            },
+            _onDownKeyed: function onDownKeyed() {
+                this.moveCursor(+1);
+            },
+            _onLeftKeyed: function onLeftKeyed() {
+                if (this.dir === "rtl" && this.input.isCursorAtEnd()) {
+                    this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable());
+                }
+            },
+            _onRightKeyed: function onRightKeyed() {
+                if (this.dir === "ltr" && this.input.isCursorAtEnd()) {
+                    this.autocomplete(this.menu.getActiveSelectable() || this.menu.getTopSelectable());
+                }
+            },
+            _onQueryChanged: function onQueryChanged(e, query) {
+                this._minLengthMet(query) ? this.menu.update(query) : this.menu.empty();
+            },
+            _onWhitespaceChanged: function onWhitespaceChanged() {
+                this._updateHint();
+            },
+            _onLangDirChanged: function onLangDirChanged(e, dir) {
+                if (this.dir !== dir) {
+                    this.dir = dir;
+                    this.menu.setLanguageDirection(dir);
+                }
+            },
+            _openIfActive: function openIfActive() {
+                this.isActive() && this.open();
+            },
+            _minLengthMet: function minLengthMet(query) {
+                query = _.isString(query) ? query : this.input.getQuery() || "";
+                return query.length >= this.minLength;
+            },
+            _updateHint: function updateHint() {
+                var $selectable, data, val, query, escapedQuery, frontMatchRegEx, match;
+                $selectable = this.menu.getTopSelectable();
+                data = this.menu.getSelectableData($selectable);
+                val = this.input.getInputValue();
+                if (data && !_.isBlankString(val) && !this.input.hasOverflow()) {
+                    query = Input.normalizeQuery(val);
+                    escapedQuery = _.escapeRegExChars(query);
+                    frontMatchRegEx = new RegExp("^(?:" + escapedQuery + ")(.+$)", "i");
+                    match = frontMatchRegEx.exec(data.val);
+                    match && this.input.setHint(val + match[1]);
+                } else {
+                    this.input.clearHint();
+                }
+            },
+            isEnabled: function isEnabled() {
+                return this.enabled;
+            },
+            enable: function enable() {
+                this.enabled = true;
+            },
+            disable: function disable() {
+                this.enabled = false;
+            },
+            isActive: function isActive() {
+                return this.active;
+            },
+            activate: function activate() {
+                if (this.isActive()) {
+                    return true;
+                } else if (!this.isEnabled() || this.eventBus.before("active")) {
+                    return false;
+                } else {
+                    this.active = true;
+                    this.eventBus.trigger("active");
+                    return true;
+                }
+            },
+            deactivate: function deactivate() {
+                if (!this.isActive()) {
+                    return true;
+                } else if (this.eventBus.before("idle")) {
+                    return false;
+                } else {
+                    this.active = false;
+                    this.close();
+                    this.eventBus.trigger("idle");
+                    return true;
+                }
+            },
+            isOpen: function isOpen() {
+                return this.menu.isOpen();
+            },
+            open: function open() {
+                if (!this.isOpen() && !this.eventBus.before("open")) {
+                    this.input.setAriaExpanded(true);
+                    this.menu.open();
+                    this._updateHint();
+                    this.eventBus.trigger("open");
+                }
+                return this.isOpen();
+            },
+            close: function close() {
+                if (this.isOpen() && !this.eventBus.before("close")) {
+                    this.input.setAriaExpanded(false);
+                    this.menu.close();
+                    this.input.clearHint();
+                    this.input.resetInputValue();
+                    this.eventBus.trigger("close");
+                }
+                return !this.isOpen();
+            },
+            setVal: function setVal(val) {
+                this.input.setQuery(_.toStr(val));
+            },
+            getVal: function getVal() {
+                return this.input.getQuery();
+            },
+            select: function select($selectable) {
+                var data = this.menu.getSelectableData($selectable);
+                if (data && !this.eventBus.before("select", data.obj, data.dataset)) {
+                    this.input.setQuery(data.val, true);
+                    this.eventBus.trigger("select", data.obj, data.dataset);
+                    this.close();
+                    return true;
+                }
+                return false;
+            },
+            autocomplete: function autocomplete($selectable) {
+                var query, data, isValid;
+                query = this.input.getQuery();
+                data = this.menu.getSelectableData($selectable);
+                isValid = data && query !== data.val;
+                if (isValid && !this.eventBus.before("autocomplete", data.obj, data.dataset)) {
+                    this.input.setQuery(data.val);
+                    this.eventBus.trigger("autocomplete", data.obj, data.dataset);
+                    return true;
+                }
+                return false;
+            },
+            moveCursor: function moveCursor(delta) {
+                var query, $candidate, data, suggestion, datasetName, cancelMove, id;
+                query = this.input.getQuery();
+                $candidate = this.menu.selectableRelativeToCursor(delta);
+                data = this.menu.getSelectableData($candidate);
+                suggestion = data ? data.obj : null;
+                datasetName = data ? data.dataset : null;
+                id = $candidate ? $candidate.attr("id") : null;
+                this.input.trigger("cursorchange", id);
+                cancelMove = this._minLengthMet() && this.menu.update(query);
+                if (!cancelMove && !this.eventBus.before("cursorchange", suggestion, datasetName)) {
+                    this.menu.setCursor($candidate);
+                    if (data) {
+                        if (typeof data.val === "string") {
+                            this.input.setInputValue(data.val);
+                        }
+                    } else {
+                        this.input.resetInputValue();
+                        this._updateHint();
+                    }
+                    this.eventBus.trigger("cursorchange", suggestion, datasetName);
+                    return true;
+                }
+                return false;
+            },
+            destroy: function destroy() {
+                this.input.destroy();
+                this.menu.destroy();
+            }
+        });
+        return Typeahead;
+        function c(ctx) {
+            var methods = [].slice.call(arguments, 1);
+            return function() {
+                var args = [].slice.call(arguments);
+                _.each(methods, function(method) {
+                    return ctx[method].apply(ctx, args);
+                });
+            };
+        }
+    }();
+    (function() {
+        "use strict";
+        var old, keys, methods;
+        old = $.fn.typeahead;
+        keys = {
+            www: "tt-www",
+            attrs: "tt-attrs",
+            typeahead: "tt-typeahead"
+        };
+        methods = {
+            initialize: function initialize(o, datasets) {
+                var www;
+                datasets = _.isArray(datasets) ? datasets : [].slice.call(arguments, 1);
+                o = o || {};
+                www = WWW(o.classNames);
+                return this.each(attach);
+                function attach() {
+                    var $input, $wrapper, $hint, $menu, defaultHint, defaultMenu, eventBus, input, menu, status, typeahead, MenuConstructor;
+                    _.each(datasets, function(d) {
+                        d.highlight = !!o.highlight;
+                    });
+                    $input = $(this);
+                    $wrapper = $(www.html.wrapper);
+                    $hint = $elOrNull(o.hint);
+                    $menu = $elOrNull(o.menu);
+                    defaultHint = o.hint !== false && !$hint;
+                    defaultMenu = o.menu !== false && !$menu;
+                    defaultHint && ($hint = buildHintFromInput($input, www));
+                    defaultMenu && ($menu = $(www.html.menu).css(www.css.menu));
+                    $hint && $hint.val("");
+                    $input = prepInput($input, www);
+                    if (defaultHint || defaultMenu) {
+                        $wrapper.css(www.css.wrapper);
+                        $input.css(defaultHint ? www.css.input : www.css.inputWithNoHint);
+                        $input.wrap($wrapper).parent().prepend(defaultHint ? $hint : null).append(defaultMenu ? $menu : null);
+                    }
+                    MenuConstructor = defaultMenu ? DefaultMenu : Menu;
+                    eventBus = new EventBus({
+                        el: $input
+                    });
+                    input = new Input({
+                        hint: $hint,
+                        input: $input,
+                        menu: $menu
+                    }, www);
+                    menu = new MenuConstructor({
+                        node: $menu,
+                        datasets: datasets
+                    }, www);
+                    status = new Status({
+                        $input: $input,
+                        menu: menu
+                    });
+                    typeahead = new Typeahead({
+                        input: input,
+                        menu: menu,
+                        eventBus: eventBus,
+                        minLength: o.minLength,
+                        autoselect: o.autoselect
+                    }, www);
+                    $input.data(keys.www, www);
+                    $input.data(keys.typeahead, typeahead);
+                }
+            },
+            isEnabled: function isEnabled() {
+                var enabled;
+                ttEach(this.first(), function(t) {
+                    enabled = t.isEnabled();
+                });
+                return enabled;
+            },
+            enable: function enable() {
+                ttEach(this, function(t) {
+                    t.enable();
+                });
+                return this;
+            },
+            disable: function disable() {
+                ttEach(this, function(t) {
+                    t.disable();
+                });
+                return this;
+            },
+            isActive: function isActive() {
+                var active;
+                ttEach(this.first(), function(t) {
+                    active = t.isActive();
+                });
+                return active;
+            },
+            activate: function activate() {
+                ttEach(this, function(t) {
+                    t.activate();
+                });
+                return this;
+            },
+            deactivate: function deactivate() {
+                ttEach(this, function(t) {
+                    t.deactivate();
+                });
+                return this;
+            },
+            isOpen: function isOpen() {
+                var open;
+                ttEach(this.first(), function(t) {
+                    open = t.isOpen();
+                });
+                return open;
+            },
+            open: function open() {
+                ttEach(this, function(t) {
+                    t.open();
+                });
+                return this;
+            },
+            close: function close() {
+                ttEach(this, function(t) {
+                    t.close();
+                });
+                return this;
+            },
+            select: function select(el) {
+                var success = false, $el = $(el);
+                ttEach(this.first(), function(t) {
+                    success = t.select($el);
+                });
+                return success;
+            },
+            autocomplete: function autocomplete(el) {
+                var success = false, $el = $(el);
+                ttEach(this.first(), function(t) {
+                    success = t.autocomplete($el);
+                });
+                return success;
+            },
+            moveCursor: function moveCursoe(delta) {
+                var success = false;
+                ttEach(this.first(), function(t) {
+                    success = t.moveCursor(delta);
+                });
+                return success;
+            },
+            val: function val(newVal) {
+                var query;
+                if (!arguments.length) {
+                    ttEach(this.first(), function(t) {
+                        query = t.getVal();
+                    });
+                    return query;
+                } else {
+                    ttEach(this, function(t) {
+                        t.setVal(_.toStr(newVal));
+                    });
+                    return this;
+                }
+            },
+            destroy: function destroy() {
+                ttEach(this, function(typeahead, $input) {
+                    revert($input);
+                    typeahead.destroy();
+                });
+                return this;
+            }
+        };
+        $.fn.typeahead = function(method) {
+            if (methods[method]) {
+                return methods[method].apply(this, [].slice.call(arguments, 1));
+            } else {
+                return methods.initialize.apply(this, arguments);
+            }
+        };
+        $.fn.typeahead.noConflict = function noConflict() {
+            $.fn.typeahead = old;
+            return this;
+        };
+        function ttEach($els, fn) {
+            $els.each(function() {
+                var $input = $(this), typeahead;
+                (typeahead = $input.data(keys.typeahead)) && fn(typeahead, $input);
+            });
+        }
+        function buildHintFromInput($input, www) {
+            return $input.clone().addClass(www.classes.hint).removeData().css(www.css.hint).css(getBackgroundStyles($input)).prop({
+                readonly: true,
+                required: false
+            }).removeAttr("id name placeholder").removeClass("required").attr({
+                spellcheck: "false",
+                tabindex: -1
+            });
+        }
+        function prepInput($input, www) {
+            $input.data(keys.attrs, {
+                dir: $input.attr("dir"),
+                autocomplete: $input.attr("autocomplete"),
+                spellcheck: $input.attr("spellcheck"),
+                style: $input.attr("style")
+            });
+            $input.addClass(www.classes.input).attr({
+                spellcheck: false
+            });
+            try {
+                !$input.attr("dir") && $input.attr("dir", "auto");
+            } catch (e) {}
+            return $input;
+        }
+        function getBackgroundStyles($el) {
+            return {
+                backgroundAttachment: $el.css("background-attachment"),
+                backgroundClip: $el.css("background-clip"),
+                backgroundColor: $el.css("background-color"),
+                backgroundImage: $el.css("background-image"),
+                backgroundOrigin: $el.css("background-origin"),
+                backgroundPosition: $el.css("background-position"),
+                backgroundRepeat: $el.css("background-repeat"),
+                backgroundSize: $el.css("background-size")
+            };
+        }
+        function revert($input) {
+            var www, $wrapper;
+            www = $input.data(keys.www);
+            $wrapper = $input.parent().filter(www.selectors.wrapper);
+            _.each($input.data(keys.attrs), function(val, key) {
+                _.isUndefined(val) ? $input.removeAttr(key) : $input.attr(key, val);
+            });
+            $input.removeData(keys.typeahead).removeData(keys.www).removeData(keys.attr).removeClass(www.classes.input);
+            if ($wrapper.length) {
+                $input.detach().insertAfter($wrapper);
+                $wrapper.remove();
+            }
+        }
+        function $elOrNull(obj) {
+            var isValid, $el;
+            isValid = _.isJQuery(obj) || _.isElement(obj);
+            $el = isValid ? $(obj).first() : [];
+            return $el.length ? $el : null;
+        }
+    })();
+});
\ No newline at end of file
diff --git a/docs/search.json b/docs/search.json
index 62fcf68..673f164 100644
--- a/docs/search.json
+++ b/docs/search.json
@@ -1 +1 @@
-{"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV4nameSSSgvp":{"name":"name","abstract":"
                                                                                                                                                                                          The name of the voice; All AVSpeechSynthesisVoice instances have a persons name.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV8languageSSSgvp":{"name":"language","abstract":"
                                                                                                                                                                                          The name of the language being used.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV12languageCodeSSSgvp":{"name":"languageCode","abstract":"
                                                                                                                                                                                          The language code is what is internationally used in Locale settings.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV10identifierypSgvp":{"name":"identifier","abstract":"
                                                                                                                                                                                          Identifier is a unique bundle url provided by Apple for each AVSpeechSynthesisVoice.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html":{"name":"OSSVoiceInfo","abstract":"
                                                                                                                                                                                          The voice infor struct ensures that the data structure has conformity and consistency.
                                                                                                                                                                                          "},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP18didFinishListening8withTextySS_tF":{"name":"didFinishListening(withText:)","abstract":"
                                                                                                                                                                                          When the microphone has finished accepting audio, this delegate will be called with the final best text output.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP25authorizationToMicrophone18withAuthenticationyAA0aB19AuthorizationStatusO_tF":{"name":"authorizationToMicrophone(withAuthentication:)","abstract":"
                                                                                                                                                                                          Handle returning authentication status to user - primary use is for non-authorized state.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP32didFailToCommenceSpeechRecordingyyF":{"name":"didFailToCommenceSpeechRecording()","abstract":"
                                                                                                                                                                                          If the speech recogniser and request fail to set up, this method will be called.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP22didCompleteTranslation8withTextySS_tF":{"name":"didCompleteTranslation(withText:)","abstract":"
                                                                                                                                                                                          Method for real time recpetion of translated text.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP23didFailToProcessRequest9withErrorys0J0_pSg_tF":{"name":"didFailToProcessRequest(withError:)","abstract":"
                                                                                                                                                                                          Error handling function.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html":{"name":"OSSSpeechDelegate","abstract":"
                                                                                                                                                                                          Delegate to handle events such as failed authentication for microphone among many more.
                                                                                                                                                                                          "},"Extensions/Bundle.html#/s:So8NSBundleC12OSSSpeechKitE18getResourcesBundleABSgyFZ":{"name":"getResourcesBundle()","abstract":"
                                                                                                                                                                                          Will return the Bundle for the SDK if it can be found.
                                                                                                                                                                                          ","parent_name":"Bundle"},"Extensions/NSObject.html#/s:So8NSObjectC12OSSSpeechKitE8debugLog6object12functionName04fileH010lineNumber7messageyyp_S2SSiSStF":{"name":"debugLog(object:functionName:fileName:lineNumber:message:)","abstract":"
                                                                                                                                                                                          Method outputs a debug statement containing necessary information to resolve issues.
                                                                                                                                                                                          ","parent_name":"NSObject"},"Extensions/NSObject.html":{"name":"NSObject"},"Extensions/Bundle.html":{"name":"Bundle","abstract":"
                                                                                                                                                                                          Bundle extension to aid in retrieving the SDK resources for getting SDK images.
                                                                                                                                                                                          "},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10AustralianyA2CmF":{"name":"Australian","abstract":"
                                                                                                                                                                                          Australian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9BrazilianyA2CmF":{"name":"Brazilian","abstract":"
                                                                                                                                                                                          Brazilian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO14CanadianFrenchyA2CmF":{"name":"CanadianFrench","abstract":"
                                                                                                                                                                                          CanadianFrench
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7ChineseyA2CmF":{"name":"Chinese","abstract":"
                                                                                                                                                                                          Chinese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO15ChineseHongKongyA2CmF":{"name":"ChineseHongKong","abstract":"
                                                                                                                                                                                          ChineseHongKong
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5CzechyA2CmF":{"name":"Czech","abstract":"
                                                                                                                                                                                          Czech
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6DanishyA2CmF":{"name":"Danish","abstract":"
                                                                                                                                                                                          Danish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO12DutchBelgiumyA2CmF":{"name":"DutchBelgium","abstract":"
                                                                                                                                                                                          DutchBelgium
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO16DutchNetherlandsyA2CmF":{"name":"DutchNetherlands","abstract":"
                                                                                                                                                                                          DutchNetherlands
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7EnglishyA2CmF":{"name":"English","abstract":"
                                                                                                                                                                                          English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7FinnishyA2CmF":{"name":"Finnish","abstract":"
                                                                                                                                                                                          Finnish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6FrenchyA2CmF":{"name":"French","abstract":"
                                                                                                                                                                                          French
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6GermanyA2CmF":{"name":"German","abstract":"
                                                                                                                                                                                          German
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5GreekyA2CmF":{"name":"Greek","abstract":"
                                                                                                                                                                                          Greek
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6HebrewyA2CmF":{"name":"Hebrew","abstract":"
                                                                                                                                                                                          Hebrew
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5HindiyA2CmF":{"name":"Hindi","abstract":"
                                                                                                                                                                                          Hindi
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9HungarianyA2CmF":{"name":"Hungarian","abstract":"
                                                                                                                                                                                          Hungarian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10IndonesianyA2CmF":{"name":"Indonesian","abstract":"
                                                                                                                                                                                          Indonesian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO12IrishEnglishyA2CmF":{"name":"IrishEnglish","abstract":"
                                                                                                                                                                                          IrishEnglish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7ItalianyA2CmF":{"name":"Italian","abstract":"
                                                                                                                                                                                          Italian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO8JapaneseyA2CmF":{"name":"Japanese","abstract":"
                                                                                                                                                                                          Japanese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6KoreanyA2CmF":{"name":"Korean","abstract":"
                                                                                                                                                                                          Korean
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7MexicanyA2CmF":{"name":"Mexican","abstract":"
                                                                                                                                                                                          Mexican
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9NorwegianyA2CmF":{"name":"Norwegian","abstract":"
                                                                                                                                                                                          Norwegian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6PolishyA2CmF":{"name":"Polish","abstract":"
                                                                                                                                                                                          Polish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10PortugueseyA2CmF":{"name":"Portuguese","abstract":"
                                                                                                                                                                                          Portuguese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO8RomanianyA2CmF":{"name":"Romanian","abstract":"
                                                                                                                                                                                          Romanian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7RussianyA2CmF":{"name":"Russian","abstract":"
                                                                                                                                                                                          Russian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO12SaudiArabianyA2CmF":{"name":"SaudiArabian","abstract":"
                                                                                                                                                                                          SaudiArabian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9SlovakianyA2CmF":{"name":"Slovakian","abstract":"
                                                                                                                                                                                          Slovakian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO19SouthAfricanEnglishyA2CmF":{"name":"SouthAfricanEnglish","abstract":"
                                                                                                                                                                                          South African English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7SpanishyA2CmF":{"name":"Spanish","abstract":"
                                                                                                                                                                                          Spanish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7SwedishyA2CmF":{"name":"Swedish","abstract":"
                                                                                                                                                                                          Swedish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9TaiwaneseyA2CmF":{"name":"Taiwanese","abstract":"
                                                                                                                                                                                          Taiwanese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO4ThaiyA2CmF":{"name":"Thai","abstract":"
                                                                                                                                                                                          Thai
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7TurkishyA2CmF":{"name":"Turkish","abstract":"
                                                                                                                                                                                          Turkish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO19UnitedStatesEnglishyA2CmF":{"name":"UnitedStatesEnglish","abstract":"
                                                                                                                                                                                          USA English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10getDetailsAA0C4InfoVyF":{"name":"getDetails()","abstract":"
                                                                                                                                                                                          Will return specific information about the language as an OSSVoiceInfo object.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5titleSSvp":{"name":"title","abstract":"
                                                                                                                                                                                          Provides the Enum key itself as a String
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO11demoMessageSSvp":{"name":"demoMessage","abstract":"
                                                                                                                                                                                          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.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO4flagSo7UIImageCSgvp":{"name":"flag","abstract":"
                                                                                                                                                                                          The flag for the selected language.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO9undefinedyA2CmF":{"name":"undefined","abstract":"
                                                                                                                                                                                          Undefined is the standard recognition type and allows the system to decide which type of task is best.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO9dictationyA2CmF":{"name":"dictation","abstract":"
                                                                                                                                                                                          Use captured speech for text entry purposes.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO6searchyA2CmF":{"name":"search","abstract":"
                                                                                                                                                                                          Use this short speechs that have specific words or terms.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO12confirmationyA2CmF":{"name":"confirmation","abstract":"
                                                                                                                                                                                          Use this for short speechs such as “Yes”, “No”, “Thanks”, etc.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO04taskE0So08SFSpeechcD4HintVvp":{"name":"taskType","abstract":"
                                                                                                                                                                                          Returns a speech recognition hint based on the enum value.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO18noMicrophoneAccessyA2CmF":{"name":"noMicrophoneAccess","abstract":"
                                                                                                                                                                                          No microphone access
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO16invalidUtteranceyA2CmF":{"name":"invalidUtterance","abstract":"
                                                                                                                                                                                          An invalid utterance.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO11invalidTextyA2CmF":{"name":"invalidText","abstract":"
                                                                                                                                                                                          Invalid text - usually an empty string.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO12invalidVoiceyA2CmF":{"name":"invalidVoice","abstract":"
                                                                                                                                                                                          The voice type is invalid.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO20invalidSpeechRequestyA2CmF":{"name":"invalidSpeechRequest","abstract":"
                                                                                                                                                                                          Speech recognition request is invalid.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO18invalidAudioEngineyA2CmF":{"name":"invalidAudioEngine","abstract":"
                                                                                                                                                                                          The audio engine is invalid.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO20recogniserUnavailbleyA2CmF":{"name":"recogniserUnavailble","abstract":"
                                                                                                                                                                                          Voice recognition is unavailable.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO12errorMessageSSvp":{"name":"errorMessage","abstract":"
                                                                                                                                                                                          The OSSSpeechKit error message string.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO012errorRequestD0SSvp":{"name":"errorRequestType","abstract":"
                                                                                                                                                                                          The highlevel type of error that occured.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO5errors0C0_pSgvp":{"name":"error","abstract":"
                                                                                                                                                                                          An error that is used to capture details of the error event.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO13notDeterminedyA2CmF":{"name":"notDetermined","abstract":"
                                                                                                                                                                                          The app’s authorization status has not yet been determined.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO6deniedyA2CmF":{"name":"denied","abstract":"
                                                                                                                                                                                          The user denied your app’s request to perform speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO10restrictedyA2CmF":{"name":"restricted","abstract":"
                                                                                                                                                                                          The device prevents your app from performing speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO10authorizedyA2CmF":{"name":"authorized","abstract":"
                                                                                                                                                                                          The user granted your app’s request to perform speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO7messageSSvp":{"name":"message","abstract":"
                                                                                                                                                                                          A public message that can be displayed to the user.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html":{"name":"OSSSpeechKitAuthorizationStatus","abstract":"
                                                                                                                                                                                          The authorization status of the Microphone and recording, imitating the native SFSpeechRecognizerAuthorizationStatus
                                                                                                                                                                                          "},"Enums/OSSSpeechKitErrorType.html":{"name":"OSSSpeechKitErrorType","abstract":"
                                                                                                                                                                                          All of the possible error types that can be thrown by OSSSpeechKit
                                                                                                                                                                                          "},"Enums/OSSSpeechRecognitionTaskType.html":{"name":"OSSSpeechRecognitionTaskType","abstract":"
                                                                                                                                                                                          The speech recognition task type.
                                                                                                                                                                                          "},"Enums/OSSVoiceEnum.html":{"name":"OSSVoiceEnum","abstract":"
                                                                                                                                                                                          The available system voices.
                                                                                                                                                                                          "},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(py)quality":{"name":"quality","abstract":"
                                                                                                                                                                                          You have access to set the voice quality or use the default which is set to .default
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(py)language":{"name":"language","abstract":"
                                                                                                                                                                                          Language offers a get and set. The default value is United States English.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/s:12OSSSpeechKit8OSSVoiceC9voiceTypeAA0C4EnumOvp":{"name":"voiceType","abstract":"
                                                                                                                                                                                          Returns the current voice type enum to allow for obtining details.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(im)init":{"name":"init()","abstract":"
                                                                                                                                                                                          If this init is used, defaults will be used.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/s:12OSSSpeechKit8OSSVoiceC7quality8languageACSgSo29AVSpeechSynthesisVoiceQualityV_AA0C4EnumOtcfc":{"name":"init(quality:language:)","abstract":"
                                                                                                                                                                                          This init method is required as it sets the voice quality and language in order to speak the text passed in.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(im)initWithCoder:":{"name":"init(coder:)","abstract":"
                                                                                                                                                                                          Required: Do not recommend using.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(py)speechString":{"name":"speechString","abstract":"
                                                                                                                                                                                          The speechString can be a constant value or changed as frequently as you wish.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(py)attributedSpeechString":{"name":"attributedSpeechString","abstract":"
                                                                                                                                                                                          The attributedSpeechString can be a constant value or changed as frequently as you wish.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)init":{"name":"init()","abstract":"
                                                                                                                                                                                          Undocumented
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)initWithString:":{"name":"init(string:)","abstract":"
                                                                                                                                                                                          Init method which will set the speechString value.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)initWithAttributedString:":{"name":"init(attributedString:)","abstract":"
                                                                                                                                                                                          Init method which will set the attributedSpeechString value.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)initWithCoder:":{"name":"init(coder:)","abstract":"
                                                                                                                                                                                          Required. Do not recommend using.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSSpeechUtility.html#/s:12OSSSpeechKit0A7UtilityC16stringsTableNameSSvp":{"name":"stringsTableName","abstract":"
                                                                                                                                                                                          Change this property to your strings table name if you wish to override the SDK strings values in your app.
                                                                                                                                                                                          ","parent_name":"OSSSpeechUtility"},"Classes/OSSSpeechUtility.html#/s:12OSSSpeechKit0A7UtilityC9getString16forLocalizedName12defaultValueS2S_SStF":{"name":"getString(forLocalizedName:defaultValue:)","abstract":"
                                                                                                                                                                                          A helper method that enables all Localized strings to be overridden by the main application.
                                                                                                                                                                                          ","parent_name":"OSSSpeechUtility"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C8delegateAA0A8Delegate_pSgvp":{"name":"delegate","abstract":"
                                                                                                                                                                                          Delegate allows for the recieving of spoken events.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C5voiceAA8OSSVoiceCSgvp":{"name":"voice","abstract":"
                                                                                                                                                                                          An object that allows overriding the default AVVoice options.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C28shouldUseOnDeviceRecognitionSbvp":{"name":"shouldUseOnDeviceRecognition","abstract":"
                                                                                                                                                                                          Speech recognition variable to determine if recognition should use on device capabilities if available
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C19recognitionTaskTypeAA0a11RecognitiondE0Ovp":{"name":"recognitionTaskType","abstract":"
                                                                                                                                                                                          The task type by default is undefined.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C9utteranceAA12OSSUtteranceCSgvp":{"name":"utterance","abstract":"
                                                                                                                                                                                          The object used to enable translation of strings to synthsized voice.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C12audioSessionSo07AVAudioD0Cvp":{"name":"audioSession","abstract":"
                                                                                                                                                                                          Audio Session can be overriden should you choose to.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C3srpSo18SFSpeechRecognizerCmvp":{"name":"srp","abstract":"
                                                                                                                                                                                          This property handles permission authorization.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C6sharedACvpZ":{"name":"shared","abstract":"
                                                                                                                                                                                          A singleton object to ensure conformity accross the application it is used in.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C9speakTextyySSSgF":{"name":"speakText(_:)","abstract":"
                                                                                                                                                                                          Pass in a string to speak.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C19speakAttributedText010attributedE0ySo18NSAttributedStringC_tF":{"name":"speakAttributedText(attributedText:)","abstract":"
                                                                                                                                                                                          Pass in an attributed string to speak.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C11recordVoice20requestMicPermissionySb_tF":{"name":"recordVoice(requestMicPermission:)","abstract":"
                                                                                                                                                                                          Record and recognise speech
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C17endVoiceRecordingyyF":{"name":"endVoiceRecording()","abstract":"
                                                                                                                                                                                          End recording of speech session if one exists.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C11engineSetupySbSo13AVAudioEngineCF":{"name":"engineSetup(_:)","abstract":"
                                                                                                                                                                                          Undocumented
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTask:didFinishSuccessfully:":{"name":"speechRecognitionTask(_:didFinishSuccessfully:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognitionTaskDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTask:didHypothesizeTranscription:":{"name":"speechRecognitionTask(_:didHypothesizeTranscription:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognitionTaskDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTask:didFinishRecognition:":{"name":"speechRecognitionTask(_:didFinishRecognition:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognitionTaskDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionDidDetectSpeech:":{"name":"speechRecognitionDidDetectSpeech(_:)","abstract":"
                                                                                                                                                                                          Undocumented
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTaskFinishedReadingAudio:":{"name":"speechRecognitionTaskFinishedReadingAudio(_:)","abstract":"
                                                                                                                                                                                          Undocumented
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognizer:availabilityDidChange:":{"name":"speechRecognizer(_:availabilityDidChange:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognizerDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html":{"name":"OSSSpeech","abstract":"
                                                                                                                                                                                          Speech is the primary interface. To use, set the voice and then call .speak(string: "your string")
                                                                                                                                                                                          "},"Classes/OSSSpeechUtility.html":{"name":"OSSSpeechUtility","abstract":"
                                                                                                                                                                                          Undocumented
                                                                                                                                                                                          "},"Classes/OSSUtterance.html":{"name":"OSSUtterance","abstract":"
                                                                                                                                                                                          OSSUtterance is a wrapper of the AVSpeechUtterance class.
                                                                                                                                                                                          "},"Classes/OSSVoice.html":{"name":"OSSVoice","abstract":"
                                                                                                                                                                                          OSSVoice overides some of the properties provided to enable setting as well as getting.
                                                                                                                                                                                          "},"Classes.html":{"name":"Classes","abstract":"
                                                                                                                                                                                          The following classes are available globally.
                                                                                                                                                                                          "},"Enums.html":{"name":"Enumerations","abstract":"
                                                                                                                                                                                          The following enumerations are available globally.
                                                                                                                                                                                          "},"Extensions.html":{"name":"Extensions","abstract":"
                                                                                                                                                                                          The following extensions are available globally.
                                                                                                                                                                                          "},"Protocols.html":{"name":"Protocols","abstract":"
                                                                                                                                                                                          The following protocols are available globally.
                                                                                                                                                                                          "},"Structs.html":{"name":"Structures","abstract":"
                                                                                                                                                                                          The following structures are available globally.
                                                                                                                                                                                          "}}
\ No newline at end of file
+{"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV4nameSSSgvp":{"name":"name","abstract":"
                                                                                                                                                                                          The name of the voice; All AVSpeechSynthesisVoice instances have a persons name.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV8languageSSSgvp":{"name":"language","abstract":"
                                                                                                                                                                                          The name of the language being used.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV12languageCodeSSSgvp":{"name":"languageCode","abstract":"
                                                                                                                                                                                          The language code is what is internationally used in Locale settings.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV10identifierypSgvp":{"name":"identifier","abstract":"
                                                                                                                                                                                          Identifier is a unique bundle URL provided by Apple for each voice.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSVoiceInfo.html#/s:12OSSSpeechKit12OSSVoiceInfoV15voiceIdentifierSSSgvp":{"name":"voiceIdentifier","abstract":"
                                                                                                                                                                                          Typed identifier for the resolved AVSpeechSynthesisVoice.
                                                                                                                                                                                          ","parent_name":"OSSVoiceInfo"},"Structs/OSSUtteranceConfiguration.html#/s:12OSSSpeechKit25OSSUtteranceConfigurationV4rateSfvp":{"name":"rate","abstract":"
                                                                                                                                                                                          Speech rate to apply to the utterance.
                                                                                                                                                                                          ","parent_name":"OSSUtteranceConfiguration"},"Structs/OSSUtteranceConfiguration.html#/s:12OSSSpeechKit25OSSUtteranceConfigurationV15pitchMultiplierSfvp":{"name":"pitchMultiplier","abstract":"
                                                                                                                                                                                          Pitch multiplier to apply to the utterance.
                                                                                                                                                                                          ","parent_name":"OSSUtteranceConfiguration"},"Structs/OSSUtteranceConfiguration.html#/s:12OSSSpeechKit25OSSUtteranceConfigurationV6volumeSfvp":{"name":"volume","abstract":"
                                                                                                                                                                                          Playback volume to apply to the utterance.
                                                                                                                                                                                          ","parent_name":"OSSUtteranceConfiguration"},"Structs/OSSUtteranceConfiguration.html#/s:12OSSSpeechKit25OSSUtteranceConfigurationV17preUtteranceDelaySdvp":{"name":"preUtteranceDelay","abstract":"
                                                                                                                                                                                          Delay before the utterance begins speaking.
                                                                                                                                                                                          ","parent_name":"OSSUtteranceConfiguration"},"Structs/OSSUtteranceConfiguration.html#/s:12OSSSpeechKit25OSSUtteranceConfigurationV18postUtteranceDelaySdvp":{"name":"postUtteranceDelay","abstract":"
                                                                                                                                                                                          Delay after the utterance finishes speaking.
                                                                                                                                                                                          ","parent_name":"OSSUtteranceConfiguration"},"Structs/OSSUtteranceConfiguration.html#/s:12OSSSpeechKit25OSSUtteranceConfigurationV4rate15pitchMultiplier6volume17preUtteranceDelay04postjK0ACSf_S2fS2dtcfc":{"name":"init(rate:pitchMultiplier:volume:preUtteranceDelay:postUtteranceDelay:)","abstract":"
                                                                                                                                                                                          Creates speech synthesis parameters for an utterance.
                                                                                                                                                                                          ","parent_name":"OSSUtteranceConfiguration"},"Structs/OSSVoiceConfiguration.html#/s:12OSSSpeechKit21OSSVoiceConfigurationV8languageAA11OSSLanguageVvp":{"name":"language","abstract":"
                                                                                                                                                                                          Language or regional variant used to search installed voices.
                                                                                                                                                                                          ","parent_name":"OSSVoiceConfiguration"},"Structs/OSSVoiceConfiguration.html#/s:12OSSSpeechKit21OSSVoiceConfigurationV19preferredIdentifierSSSgvp":{"name":"preferredIdentifier","abstract":"
                                                                                                                                                                                          Specific AVFoundation voice identifier to prefer when available.
                                                                                                                                                                                          ","parent_name":"OSSVoiceConfiguration"},"Structs/OSSVoiceConfiguration.html#/s:12OSSSpeechKit21OSSVoiceConfigurationV16preferredQualitySo022AVSpeechSynthesisVoiceF0VSgvp":{"name":"preferredQuality","abstract":"
                                                                                                                                                                                          Preferred voice quality to use when multiple voices match the language.
                                                                                                                                                                                          ","parent_name":"OSSVoiceConfiguration"},"Structs/OSSVoiceConfiguration.html#/s:12OSSSpeechKit21OSSVoiceConfigurationV8language19preferredIdentifier0F7QualityAcA11OSSLanguageV_SSSgSo022AVSpeechSynthesisVoiceH0VSgtcfc":{"name":"init(language:preferredIdentifier:preferredQuality:)","abstract":"
                                                                                                                                                                                          Creates a voice selection request.
                                                                                                                                                                                          ","parent_name":"OSSVoiceConfiguration"},"Structs/OSSVoiceConfiguration.html#/s:12OSSSpeechKit21OSSVoiceConfigurationV7resolveSo22AVSpeechSynthesisVoiceCSgyF":{"name":"resolve()","abstract":"
                                                                                                                                                                                          Resolves the best currently available system voice without relying on","parent_name":"OSSVoiceConfiguration"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV2idSSvp":{"name":"id","abstract":"
                                                                                                                                                                                          Stable identifier used by OSSSpeechKit to refer to this catalog entry.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV4nameSSvp":{"name":"name","abstract":"
                                                                                                                                                                                          Human-readable language or regional variant name for display.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV6locale10Foundation6LocaleVvp":{"name":"locale","abstract":"
                                                                                                                                                                                          Foundation locale that describes the language and region.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV10regionCodeSSSgvp":{"name":"regionCode","abstract":"
                                                                                                                                                                                          Region override used when the locale alone cannot distinguish a variant.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV25preferredVoiceIdentifiersSaySSGvp":{"name":"preferredVoiceIdentifiers","abstract":"
                                                                                                                                                                                          Voice identifiers that should be preferred when matching installed voices.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV2id4name16localeIdentifier10regionCode25preferredVoiceIdentifiersACSS_S3SSgSaySSGtcfc":{"name":"init(id:name:localeIdentifier:regionCode:preferredVoiceIdentifiers:)","abstract":"
                                                                                                                                                                                          Creates language metadata for the OSSSpeechKit catalog.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV16localeIdentifierSSvp":{"name":"localeIdentifier","abstract":"
                                                                                                                                                                                          The canonicalized BCP 47 identifier used for runtime capability checks.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV24availableSynthesisVoicesSaySo08AVSpeechE5VoiceCGvp":{"name":"availableSynthesisVoices","abstract":"
                                                                                                                                                                                          Voices currently installed or exposed by the operating system.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV19supportsRecognitionSbvp":{"name":"supportsRecognition","abstract":"
                                                                                                                                                                                          Whether the legacy Speech recognizer reports this locale as supported.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV26supportedRecognitionLocale12equivalentTo10Foundation0F0VSgAH_tFZ":{"name":"supportedRecognitionLocale(equivalentTo:)","abstract":"
                                                                                                                                                                                          Returns the exact supported recognition locale, or a same-language,","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV9flagEmojiSSvp":{"name":"flagEmoji","abstract":"
                                                                                                                                                                                          A Unicode flag suitable for labels, SwiftUI Text, and accessibility.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV17renderedFlagImage9pointSize5scaleSo7UIImageC14CoreFoundation7CGFloatV_AKtF":{"name":"renderedFlagImage(pointSize:scale:)","abstract":"
                                                                                                                                                                                          Renders flagEmoji to an image for UIKit clients that require one.
                                                                                                                                                                                          ","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html#/s:12OSSSpeechKit11OSSLanguageV7catalogSayACGvpZ":{"name":"catalog","abstract":"
                                                                                                                                                                                          Curated languages and regional variants described by Apple’s current","parent_name":"OSSLanguage"},"Structs/OSSLanguage.html":{"name":"OSSLanguage","abstract":"
                                                                                                                                                                                          Display metadata for a language or regional voice supported by Apple platforms.
                                                                                                                                                                                          "},"Structs/OSSVoiceConfiguration.html":{"name":"OSSVoiceConfiguration","abstract":"
                                                                                                                                                                                          Selects an actual voice exposed by AVFoundation.
                                                                                                                                                                                          "},"Structs/OSSUtteranceConfiguration.html":{"name":"OSSUtteranceConfiguration","abstract":"
                                                                                                                                                                                          Value-style speech parameters used to construct a fresh AVFoundation"},"Structs/OSSVoiceInfo.html":{"name":"OSSVoiceInfo","abstract":"
                                                                                                                                                                                          Information about a resolved system voice.
                                                                                                                                                                                          "},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP18didFinishListening8withTextySS_tF":{"name":"didFinishListening(withText:)","abstract":"
                                                                                                                                                                                          When the microphone has finished accepting audio, this delegate will be called with the final best text output.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP25authorizationToMicrophone18withAuthenticationyAA0aB19AuthorizationStatusO_tF":{"name":"authorizationToMicrophone(withAuthentication:)","abstract":"
                                                                                                                                                                                          Handle returning authentication status to user - primary use is for non-authorized state.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP32didFailToCommenceSpeechRecordingyyF":{"name":"didFailToCommenceSpeechRecording()","abstract":"
                                                                                                                                                                                          If the speech recogniser and request fail to set up, this method will be called.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP22didCompleteTranslation8withTextySS_tF":{"name":"didCompleteTranslation(withText:)","abstract":"
                                                                                                                                                                                          Method for real time recpetion of translated text.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html#/s:12OSSSpeechKit0A8DelegateP23didFailToProcessRequest9withErrorys0J0_pSg_tF":{"name":"didFailToProcessRequest(withError:)","abstract":"
                                                                                                                                                                                          Error handling function.
                                                                                                                                                                                          ","parent_name":"OSSSpeechDelegate"},"Protocols/OSSSpeechDelegate.html":{"name":"OSSSpeechDelegate","abstract":"
                                                                                                                                                                                          Delegate to handle events such as failed authentication for microphone among many more.
                                                                                                                                                                                          "},"Extensions/NSObject.html#/s:So8NSObjectC12OSSSpeechKitE8debugLog6object12functionName04fileH010lineNumber7messageyyp_S2SSiSStF":{"name":"debugLog(object:functionName:fileName:lineNumber:message:)","abstract":"
                                                                                                                                                                                          Method outputs a debug statement containing necessary information to resolve issues.
                                                                                                                                                                                          ","parent_name":"NSObject"},"Extensions/NSObject.html":{"name":"NSObject"},"Enums/OSSSpeechRecognitionEvent.html#/s:12OSSSpeechKit0A16RecognitionEventO7partialyACSScACmF":{"name":"partial(_:)","abstract":"
                                                                                                                                                                                          Interim transcription text emitted before recognition completes.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionEvent"},"Enums/OSSSpeechRecognitionEvent.html#/s:12OSSSpeechKit0A16RecognitionEventO9completedyACSScACmF":{"name":"completed(_:)","abstract":"
                                                                                                                                                                                          Final transcription text emitted when recognition completes.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionEvent"},"Enums/OSSSpeechRecognitionEvent.html#/s:12OSSSpeechKit0A16RecognitionEventO19availabilityChangedyACSbcACmF":{"name":"availabilityChanged(_:)","abstract":"
                                                                                                                                                                                          Availability updates reported by the underlying speech recognizer.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionEvent"},"Enums/OSSSpeechRecognitionEvent.html#/s:12OSSSpeechKit0A16RecognitionEventO9cancelledyA2CmF":{"name":"cancelled","abstract":"
                                                                                                                                                                                          Recognition was cancelled before producing a final result.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionEvent"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO9emptyTextyA2CmF":{"name":"emptyText","abstract":"
                                                                                                                                                                                          The provided speech text was empty or only whitespace.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO16voiceUnavailableyACSS_tcACmF":{"name":"voiceUnavailable(localeIdentifier:)","abstract":"
                                                                                                                                                                                          No installed speech synthesis voice matched the requested locale.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO25speechAuthorizationDeniedyA2CmF":{"name":"speechAuthorizationDenied","abstract":"
                                                                                                                                                                                          Speech recognition authorization was denied or unavailable.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO29microphoneAuthorizationDeniedyA2CmF":{"name":"microphoneAuthorizationDenied","abstract":"
                                                                                                                                                                                          Microphone recording authorization was denied or unavailable.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO28recognitionLocaleUnsupportedyACSScACmF":{"name":"recognitionLocaleUnsupported(_:)","abstract":"
                                                                                                                                                                                          Speech recognition does not support the requested locale on this device.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO21recognizerUnavailableyA2CmF":{"name":"recognizerUnavailable","abstract":"
                                                                                                                                                                                          The speech recognizer exists but is not currently available.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO18audioEngineFailureyACs0C0_pSg_tcACmF":{"name":"audioEngineFailure(underlying:)","abstract":"
                                                                                                                                                                                          AVFoundation could not configure or start the audio engine/session.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:12OSSSpeechKit0A5ErrorO19operationInProgressyA2CmF":{"name":"operationInProgress","abstract":"
                                                                                                                                                                                          A speech synthesis or recognition operation is already active.
                                                                                                                                                                                          ","parent_name":"OSSSpeechError"},"Enums/OSSSpeechError.html#/s:10Foundation14LocalizedErrorP16errorDescriptionSSSgvp":{"name":"errorDescription","parent_name":"OSSSpeechError"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO9undefinedyA2CmF":{"name":"undefined","abstract":"
                                                                                                                                                                                          Undefined is the standard recognition type and allows the system to decide which type of task is best.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO9dictationyA2CmF":{"name":"dictation","abstract":"
                                                                                                                                                                                          Use captured speech for text entry purposes.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO6searchyA2CmF":{"name":"search","abstract":"
                                                                                                                                                                                          Use this short speechs that have specific words or terms.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO12confirmationyA2CmF":{"name":"confirmation","abstract":"
                                                                                                                                                                                          Use this for short speechs such as “Yes”, “No”, “Thanks”, etc.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechRecognitionTaskType.html#/s:12OSSSpeechKit0A19RecognitionTaskTypeO04taskE0So08SFSpeechcD4HintVvp":{"name":"taskType","abstract":"
                                                                                                                                                                                          Returns a speech recognition hint based on the enum value.
                                                                                                                                                                                          ","parent_name":"OSSSpeechRecognitionTaskType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO18noMicrophoneAccessyA2CmF":{"name":"noMicrophoneAccess","abstract":"
                                                                                                                                                                                          No microphone access
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO16invalidUtteranceyA2CmF":{"name":"invalidUtterance","abstract":"
                                                                                                                                                                                          An invalid utterance.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO11invalidTextyA2CmF":{"name":"invalidText","abstract":"
                                                                                                                                                                                          Invalid text - usually an empty string.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO12invalidVoiceyA2CmF":{"name":"invalidVoice","abstract":"
                                                                                                                                                                                          The voice type is invalid.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO20invalidSpeechRequestyA2CmF":{"name":"invalidSpeechRequest","abstract":"
                                                                                                                                                                                          Speech recognition request is invalid.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO18invalidAudioEngineyA2CmF":{"name":"invalidAudioEngine","abstract":"
                                                                                                                                                                                          The audio engine is invalid.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO20recogniserUnavailbleyA2CmF":{"name":"recogniserUnavailble","abstract":"
                                                                                                                                                                                          Voice recognition is unavailable.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO12errorMessageSSvp":{"name":"errorMessage","abstract":"
                                                                                                                                                                                          The OSSSpeechKit error message string.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO012errorRequestD0SSvp":{"name":"errorRequestType","abstract":"
                                                                                                                                                                                          The highlevel type of error that occured.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitErrorType.html#/s:12OSSSpeechKit0aB9ErrorTypeO5errors0C0_pSgvp":{"name":"error","abstract":"
                                                                                                                                                                                          An error that is used to capture details of the error event.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitErrorType"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO13notDeterminedyA2CmF":{"name":"notDetermined","abstract":"
                                                                                                                                                                                          The app’s authorization status has not yet been determined.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO6deniedyA2CmF":{"name":"denied","abstract":"
                                                                                                                                                                                          The user denied your app’s request to perform speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO10restrictedyA2CmF":{"name":"restricted","abstract":"
                                                                                                                                                                                          The device prevents your app from performing speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO10authorizedyA2CmF":{"name":"authorized","abstract":"
                                                                                                                                                                                          The user granted your app’s request to perform speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSSpeechKitAuthorizationStatus.html#/s:12OSSSpeechKit0aB19AuthorizationStatusO7messageSSvp":{"name":"message","abstract":"
                                                                                                                                                                                          A public message that can be displayed to the user.
                                                                                                                                                                                          ","parent_name":"OSSSpeechKitAuthorizationStatus"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10AustralianyA2CmF":{"name":"Australian","abstract":"
                                                                                                                                                                                          Australian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9BrazilianyA2CmF":{"name":"Brazilian","abstract":"
                                                                                                                                                                                          Brazilian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9BulgarianyA2CmF":{"name":"Bulgarian","abstract":"
                                                                                                                                                                                          Bulgarian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO14CanadianFrenchyA2CmF":{"name":"CanadianFrench","abstract":"
                                                                                                                                                                                          CanadianFrench
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7ChineseyA2CmF":{"name":"Chinese","abstract":"
                                                                                                                                                                                          Chinese Traditional
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO17ChineseSimplifiedyA2CmF":{"name":"ChineseSimplified","abstract":"
                                                                                                                                                                                          Chinese Simplified
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO15ChineseHongKongyA2CmF":{"name":"ChineseHongKong","abstract":"
                                                                                                                                                                                          ChineseHongKong
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO8CroatianyA2CmF":{"name":"Croatian","abstract":"
                                                                                                                                                                                          Croatian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5CzechyA2CmF":{"name":"Czech","abstract":"
                                                                                                                                                                                          Czech
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6DanishyA2CmF":{"name":"Danish","abstract":"
                                                                                                                                                                                          Danish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO12DutchBelgiumyA2CmF":{"name":"DutchBelgium","abstract":"
                                                                                                                                                                                          DutchBelgium
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO16DutchNetherlandsyA2CmF":{"name":"DutchNetherlands","abstract":"
                                                                                                                                                                                          DutchNetherlands
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7EnglishyA2CmF":{"name":"English","abstract":"
                                                                                                                                                                                          English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7FinnishyA2CmF":{"name":"Finnish","abstract":"
                                                                                                                                                                                          Finnish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6FrenchyA2CmF":{"name":"French","abstract":"
                                                                                                                                                                                          French
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6GermanyA2CmF":{"name":"German","abstract":"
                                                                                                                                                                                          German
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5GreekyA2CmF":{"name":"Greek","abstract":"
                                                                                                                                                                                          Greek
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6HebrewyA2CmF":{"name":"Hebrew","abstract":"
                                                                                                                                                                                          Hebrew
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5HindiyA2CmF":{"name":"Hindi","abstract":"
                                                                                                                                                                                          Hindi
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9HungarianyA2CmF":{"name":"Hungarian","abstract":"
                                                                                                                                                                                          Hungarian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO13IndianEnglishyA2CmF":{"name":"IndianEnglish","abstract":"
                                                                                                                                                                                          Indian English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10IndonesianyA2CmF":{"name":"Indonesian","abstract":"
                                                                                                                                                                                          Indonesian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO12IrishEnglishyA2CmF":{"name":"IrishEnglish","abstract":"
                                                                                                                                                                                          IrishEnglish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7ItalianyA2CmF":{"name":"Italian","abstract":"
                                                                                                                                                                                          Italian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO8JapaneseyA2CmF":{"name":"Japanese","abstract":"
                                                                                                                                                                                          Japanese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6KoreanyA2CmF":{"name":"Korean","abstract":"
                                                                                                                                                                                          Korean
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5MalayyA2CmF":{"name":"Malay","abstract":"
                                                                                                                                                                                          Malaysian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7MexicanyA2CmF":{"name":"Mexican","abstract":"
                                                                                                                                                                                          Mexican
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9NorwegianyA2CmF":{"name":"Norwegian","abstract":"
                                                                                                                                                                                          Norwegian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO15NorwegianBokmalyA2CmF":{"name":"NorwegianBokmal","abstract":"
                                                                                                                                                                                          Norwegian Bokmal
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO6PolishyA2CmF":{"name":"Polish","abstract":"
                                                                                                                                                                                          Polish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10PortugueseyA2CmF":{"name":"Portuguese","abstract":"
                                                                                                                                                                                          Portuguese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO8RomanianyA2CmF":{"name":"Romanian","abstract":"
                                                                                                                                                                                          Romanian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7RussianyA2CmF":{"name":"Russian","abstract":"
                                                                                                                                                                                          Russian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO12SaudiArabianyA2CmF":{"name":"SaudiArabian","abstract":"
                                                                                                                                                                                          SaudiArabian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9SlovakianyA2CmF":{"name":"Slovakian","abstract":"
                                                                                                                                                                                          Slovakian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO19SouthAfricanEnglishyA2CmF":{"name":"SouthAfricanEnglish","abstract":"
                                                                                                                                                                                          South African English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7SpanishyA2CmF":{"name":"Spanish","abstract":"
                                                                                                                                                                                          Spanish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO14SpanishCatalanyA2CmF":{"name":"SpanishCatalan","abstract":"
                                                                                                                                                                                          Catalan
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7SwedishyA2CmF":{"name":"Swedish","abstract":"
                                                                                                                                                                                          Swedish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9TaiwaneseyA2CmF":{"name":"Taiwanese","abstract":"
                                                                                                                                                                                          Taiwanese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO4ThaiyA2CmF":{"name":"Thai","abstract":"
                                                                                                                                                                                          Thai
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO7TurkishyA2CmF":{"name":"Turkish","abstract":"
                                                                                                                                                                                          Turkish
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO8UkranianyA2CmF":{"name":"Ukranian","abstract":"
                                                                                                                                                                                          Ukranian
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO19UnitedStatesEnglishyA2CmF":{"name":"UnitedStatesEnglish","abstract":"
                                                                                                                                                                                          USA English
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10VietnameseyA2CmF":{"name":"Vietnamese","abstract":"
                                                                                                                                                                                          Vietnamese
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO11ArabicWorldyA2CmF":{"name":"ArabicWorld","abstract":"
                                                                                                                                                                                          Arabic World
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO10getDetailsAA0C4InfoVyF":{"name":"getDetails()","abstract":"
                                                                                                                                                                                          Will return specific information about the language as an OSSVoiceInfo object.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO5titleSSvp":{"name":"title","abstract":"
                                                                                                                                                                                          Provides the Enum key itself as a String
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO11demoMessageSSvp":{"name":"demoMessage","abstract":"
                                                                                                                                                                                          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.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO4flagSo7UIImageCSgvp":{"name":"flag","abstract":"
                                                                                                                                                                                          The legacy image flag for the selected language.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO25canonicalLocaleIdentifierSSvp":{"name":"canonicalLocaleIdentifier","abstract":"
                                                                                                                                                                                          The canonical locale used by the modern API.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO16languageMetadataAA11OSSLanguageVvp":{"name":"languageMetadata","abstract":"
                                                                                                                                                                                          Modern metadata corresponding to this legacy case.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO9flagEmojiSSvp":{"name":"flagEmoji","abstract":"
                                                                                                                                                                                          Preferred Unicode replacement for the legacy image property.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html#/s:12OSSSpeechKit12OSSVoiceEnumO17renderedFlagImage9pointSize5scaleSo7UIImageC14CoreFoundation7CGFloatV_AKtF":{"name":"renderedFlagImage(pointSize:scale:)","abstract":"
                                                                                                                                                                                          Renders flagEmoji for UIKit clients.
                                                                                                                                                                                          ","parent_name":"OSSVoiceEnum"},"Enums/OSSVoiceEnum.html":{"name":"OSSVoiceEnum","abstract":"
                                                                                                                                                                                          The available system voices.
                                                                                                                                                                                          "},"Enums/OSSSpeechKitAuthorizationStatus.html":{"name":"OSSSpeechKitAuthorizationStatus","abstract":"
                                                                                                                                                                                          The authorization status of the Microphone and recording, imitating the native SFSpeechRecognizerAuthorizationStatus
                                                                                                                                                                                          "},"Enums/OSSSpeechKitErrorType.html":{"name":"OSSSpeechKitErrorType","abstract":"
                                                                                                                                                                                          All of the possible error types that can be thrown by OSSSpeechKit
                                                                                                                                                                                          "},"Enums/OSSSpeechRecognitionTaskType.html":{"name":"OSSSpeechRecognitionTaskType","abstract":"
                                                                                                                                                                                          The speech recognition task type.
                                                                                                                                                                                          "},"Enums/OSSSpeechError.html":{"name":"OSSSpeechError","abstract":"
                                                                                                                                                                                          Typed failures emitted by the modern OSSSpeechKit API.
                                                                                                                                                                                          "},"Enums/OSSSpeechRecognitionEvent.html":{"name":"OSSSpeechRecognitionEvent","abstract":"
                                                                                                                                                                                          Events from a live recognition session.
                                                                                                                                                                                          "},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(py)quality":{"name":"quality","abstract":"
                                                                                                                                                                                          You have access to set the voice quality or use the default which is set to .default
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(py)language":{"name":"language","abstract":"
                                                                                                                                                                                          Language offers a get and set. The default value is United States English.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/s:12OSSSpeechKit8OSSVoiceC9voiceTypeAA0C4EnumOvp":{"name":"voiceType","abstract":"
                                                                                                                                                                                          Returns the current voice type enum to allow for obtining details.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(im)init":{"name":"init()","abstract":"
                                                                                                                                                                                          If this init is used, defaults will be used.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/s:12OSSSpeechKit8OSSVoiceC7quality8languageACSgSo29AVSpeechSynthesisVoiceQualityV_AA0C4EnumOtcfc":{"name":"init(quality:language:)","abstract":"
                                                                                                                                                                                          This init method is required as it sets the voice quality and language in order to speak the text passed in.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSVoice.html#/c:@M@OSSSpeechKit@objc(cs)OSSVoice(im)initWithCoder:":{"name":"init(coder:)","abstract":"
                                                                                                                                                                                          Required: Do not recommend using.
                                                                                                                                                                                          ","parent_name":"OSSVoice"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(py)speechString":{"name":"speechString","abstract":"
                                                                                                                                                                                          The speechString can be a constant value or changed as frequently as you wish.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(py)attributedSpeechString":{"name":"attributedSpeechString","abstract":"
                                                                                                                                                                                          The attributedSpeechString can be a constant value or changed as frequently as you wish.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)init":{"name":"init()","abstract":"
                                                                                                                                                                                          Creates an error placeholder utterance.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)initWithString:":{"name":"init(string:)","abstract":"
                                                                                                                                                                                          Init method which will set the speechString value.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)initWithAttributedString:":{"name":"init(attributedString:)","abstract":"
                                                                                                                                                                                          Init method which will set the attributedSpeechString value.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSUtterance.html#/c:@M@OSSSpeechKit@objc(cs)OSSUtterance(im)initWithCoder:":{"name":"init(coder:)","abstract":"
                                                                                                                                                                                          Required. Do not recommend using.
                                                                                                                                                                                          ","parent_name":"OSSUtterance"},"Classes/OSSSpeechUtility.html#/s:12OSSSpeechKit0A7UtilityC16stringsTableNameSSvp":{"name":"stringsTableName","abstract":"
                                                                                                                                                                                          Change this property to your strings table name if you wish to override the SDK strings values in your app.
                                                                                                                                                                                          ","parent_name":"OSSSpeechUtility"},"Classes/OSSSpeechUtility.html#/s:12OSSSpeechKit0A7UtilityC9getString16forLocalizedName12defaultValueS2S_SStF":{"name":"getString(forLocalizedName:defaultValue:)","abstract":"
                                                                                                                                                                                          A helper method that enables all Localized strings to be overridden by the main application.
                                                                                                                                                                                          ","parent_name":"OSSSpeechUtility"},"Classes/OSSSpeechEngine/State.html#/s:12OSSSpeechKit0A6EngineC5StateO4idleyA2EmF":{"name":"idle","abstract":"
                                                                                                                                                                                          The engine is not speaking or listening.
                                                                                                                                                                                          ","parent_name":"State"},"Classes/OSSSpeechEngine/State.html#/s:12OSSSpeechKit0A6EngineC5StateO8speakingyA2EmF":{"name":"speaking","abstract":"
                                                                                                                                                                                          The engine is currently synthesizing speech.
                                                                                                                                                                                          ","parent_name":"State"},"Classes/OSSSpeechEngine/State.html#/s:12OSSSpeechKit0A6EngineC5StateO9listeningyA2EmF":{"name":"listening","abstract":"
                                                                                                                                                                                          The engine is currently recording and recognizing speech.
                                                                                                                                                                                          ","parent_name":"State"},"Classes/OSSSpeechEngine/State.html":{"name":"State","abstract":"
                                                                                                                                                                                          Current high-level activity of the speech engine.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC5stateAC5StateOvp":{"name":"state","abstract":"
                                                                                                                                                                                          Current high-level activity of the engine.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC23usesOnDeviceRecognitionSbvp":{"name":"usesOnDeviceRecognition","abstract":"
                                                                                                                                                                                          Whether recognition should require on-device processing when supported.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC19recognitionTaskHintSo019SFSpeechRecognitioneF0Vvp":{"name":"recognitionTaskHint","abstract":"
                                                                                                                                                                                          Task hint passed to the underlying speech recognizer.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/c:@M@OSSSpeechKit@objc(cs)OSSSpeechEngine(im)init":{"name":"init()","abstract":"
                                                                                                                                                                                          Creates a speech engine with its own synthesizer, audio engine, and audio session.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC27supportedRecognitionLocalesShy10Foundation6LocaleVGvpZ":{"name":"supportedRecognitionLocales","abstract":"
                                                                                                                                                                                          Locales that the platform reports as available for speech recognition.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC26requestSpeechAuthorizationAA0abF6StatusOyYaF":{"name":"requestSpeechAuthorization()","abstract":"
                                                                                                                                                                                          Requests speech recognition authorization and maps the native status.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC30requestMicrophoneAuthorizationSbyYaF":{"name":"requestMicrophoneAuthorization()","abstract":"
                                                                                                                                                                                          Requests microphone recording authorization.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC5speak_5voice13configurationySS_AA21OSSVoiceConfigurationVAA012OSSUtteranceH0VtYaKF":{"name":"speak(_:voice:configuration:)","abstract":"
                                                                                                                                                                                          Speaks plain text using a resolved AVFoundation voice.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC5speak_5voice13configurationySo18NSAttributedStringC_AA21OSSVoiceConfigurationVAA012OSSUtteranceJ0VtYaKF":{"name":"speak(_:voice:configuration:)","abstract":"
                                                                                                                                                                                          Speaks attributed text using a resolved AVFoundation voice.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC13pauseSpeakingyyF":{"name":"pauseSpeaking()","abstract":"
                                                                                                                                                                                          Pauses the current utterance immediately when the engine is speaking.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC16continueSpeakingyyF":{"name":"continueSpeaking()","abstract":"
                                                                                                                                                                                          Resumes a paused utterance.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC12stopSpeakingyyF":{"name":"stopSpeaking()","abstract":"
                                                                                                                                                                                          Stops the current utterance and finishes the synthesis operation.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC17recognitionEvents6locale20requestAuthorizationScsyAA0A16RecognitionEventOs5Error_pG10Foundation6LocaleV_SbtYaKF":{"name":"recognitionEvents(locale:requestAuthorization:)","abstract":"
                                                                                                                                                                                          Starts recognition and returns a stream that owns the recording session.","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/s:12OSSSpeechKit0A6EngineC17cancelRecognitionyyF":{"name":"cancelRecognition()","abstract":"
                                                                                                                                                                                          Cancels the active recognition session and tears down audio recording.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeechEngine(im)speechSynthesizer:didFinishSpeechUtterance:":{"name":"speechSynthesizer(_:didFinish:)","abstract":"
                                                                                                                                                                                          Completes the awaiting synthesis operation when AVFoundation finishes speaking.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeechEngine(im)speechSynthesizer:didCancelSpeechUtterance:":{"name":"speechSynthesizer(_:didCancel:)","abstract":"
                                                                                                                                                                                          Completes the awaiting synthesis operation with cancellation when speech is cancelled.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeechEngine.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeechEngine(im)speechRecognizer:availabilityDidChange:":{"name":"speechRecognizer(_:availabilityDidChange:)","abstract":"
                                                                                                                                                                                          Emits recognizer availability changes to the active recognition stream.
                                                                                                                                                                                          ","parent_name":"OSSSpeechEngine"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C8delegateAA0A8Delegate_pSgvp":{"name":"delegate","abstract":"
                                                                                                                                                                                          Delegate allows for the recieving of spoken events.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C5voiceAA8OSSVoiceCSgvp":{"name":"voice","abstract":"
                                                                                                                                                                                          An object that allows overriding the default AVVoice options.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C28shouldUseOnDeviceRecognitionSbvp":{"name":"shouldUseOnDeviceRecognition","abstract":"
                                                                                                                                                                                          Speech recognition variable to determine if recognition should use on device capabilities if available
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C19recognitionTaskTypeAA0a11RecognitiondE0Ovp":{"name":"recognitionTaskType","abstract":"
                                                                                                                                                                                          The task type by default is undefined.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C9utteranceAA12OSSUtteranceCSgvp":{"name":"utterance","abstract":"
                                                                                                                                                                                          The object used to enable translation of strings to synthsized voice.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C12audioSessionSo07AVAudioD0Cvp":{"name":"audioSession","abstract":"
                                                                                                                                                                                          Audio Session can be overriden should you choose to.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C3srpSo18SFSpeechRecognizerCmvp":{"name":"srp","abstract":"
                                                                                                                                                                                          This property handles permission authorization.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C17speechSynthesizerACSo08AVSpeechD0C_tcfc":{"name":"init(speechSynthesizer:)","abstract":"
                                                                                                                                                                                          Allow injection of the AVSpeechSynthesizer so that caller can be AVSpeechSynthesizerDelegate","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C6sharedACvpZ":{"name":"shared","abstract":"
                                                                                                                                                                                          A singleton object to ensure conformity accross the application it is used in.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C9speakTextyySSSgF":{"name":"speakText(_:)","abstract":"
                                                                                                                                                                                          Pass in a string to speak.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C19speakAttributedText010attributedE0ySo18NSAttributedStringC_tF":{"name":"speakAttributedText(attributedText:)","abstract":"
                                                                                                                                                                                          Pass in an attributed string to speak.","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C13pauseSpeakingyyF":{"name":"pauseSpeaking()","abstract":"
                                                                                                                                                                                          Pause speaking text
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C16continueSpeakingyyF":{"name":"continueSpeaking()","abstract":"
                                                                                                                                                                                          Continue speaking text
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C12stopSpeakingyyF":{"name":"stopSpeaking()","abstract":"
                                                                                                                                                                                          Force the ending of speaking.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C11recordVoice20requestMicPermissionySb_tF":{"name":"recordVoice(requestMicPermission:)","abstract":"
                                                                                                                                                                                          Record and recognise speech
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/s:12OSSSpeechKit0A0C17endVoiceRecordingyyF":{"name":"endVoiceRecording()","abstract":"
                                                                                                                                                                                          End recording of speech session if one exists.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTask:didFinishSuccessfully:":{"name":"speechRecognitionTask(_:didFinishSuccessfully:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognitionTaskDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTask:didHypothesizeTranscription:":{"name":"speechRecognitionTask(_:didHypothesizeTranscription:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognitionTaskDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTask:didFinishRecognition:":{"name":"speechRecognitionTask(_:didFinishRecognition:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognitionTaskDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionDidDetectSpeech:":{"name":"speechRecognitionDidDetectSpeech(_:)","abstract":"
                                                                                                                                                                                          Called when the recognizer detects speech in the audio stream.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognitionTaskFinishedReadingAudio:":{"name":"speechRecognitionTaskFinishedReadingAudio(_:)","abstract":"
                                                                                                                                                                                          Called when the recognizer has finished reading audio from the request.
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html#/c:@CM@OSSSpeechKit@objc(cs)OSSSpeech(im)speechRecognizer:availabilityDidChange:":{"name":"speechRecognizer(_:availabilityDidChange:)","abstract":"
                                                                                                                                                                                          Docs available by Google searching for SFSpeechRecognizerDelegate
                                                                                                                                                                                          ","parent_name":"OSSSpeech"},"Classes/OSSSpeech.html":{"name":"OSSSpeech","abstract":"
                                                                                                                                                                                          Speech is the primary interface. To use, set the voice and then call .speak(string: "your string")
                                                                                                                                                                                          "},"Classes/OSSSpeechEngine.html":{"name":"OSSSpeechEngine","abstract":"
                                                                                                                                                                                          Instance-based, main-actor-isolated speech synthesis and recognition engine.
                                                                                                                                                                                          "},"Classes/OSSSpeechUtility.html":{"name":"OSSSpeechUtility","abstract":"
                                                                                                                                                                                          Utility methods for localized strings and diagnostics used by OSSSpeechKit.
                                                                                                                                                                                          "},"Classes/OSSUtterance.html":{"name":"OSSUtterance","abstract":"
                                                                                                                                                                                          OSSUtterance is a wrapper of the AVSpeechUtterance class.
                                                                                                                                                                                          "},"Classes/OSSVoice.html":{"name":"OSSVoice","abstract":"
                                                                                                                                                                                          OSSVoice overides some of the properties provided to enable setting as well as getting.
                                                                                                                                                                                          "},"Classes.html":{"name":"Classes","abstract":"
                                                                                                                                                                                          The following classes are available globally.
                                                                                                                                                                                          "},"Enums.html":{"name":"Enumerations","abstract":"
                                                                                                                                                                                          The following enumerations are available globally.
                                                                                                                                                                                          "},"Extensions.html":{"name":"Extensions","abstract":"
                                                                                                                                                                                          The following extensions are available globally.
                                                                                                                                                                                          "},"Protocols.html":{"name":"Protocols","abstract":"
                                                                                                                                                                                          The following protocols are available globally.
                                                                                                                                                                                          "},"Structs.html":{"name":"Structures","abstract":"
                                                                                                                                                                                          The following structures are available globally.
                                                                                                                                                                                          "}}
\ No newline at end of file
diff --git a/docs/undocumented.json b/docs/undocumented.json
index 8c0cc05..90f2a03 100644
--- a/docs/undocumented.json
+++ b/docs/undocumented.json
@@ -1,40 +1,6 @@
 {
   "warnings": [
-    {
-      "file": "/Users/seansmith/SeansDev/OSSSpeechKit/OSSSpeechKit/Classes/OSSSpeech.swift",
-      "line": 385,
-      "symbol": "OSSSpeech.engineSetup(_:)",
-      "symbol_kind": "source.lang.swift.decl.function.method.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/seansmith/SeansDev/OSSSpeechKit/OSSSpeechKit/Classes/OSSSpeech.swift",
-      "line": 505,
-      "symbol": "OSSSpeech.speechRecognitionDidDetectSpeech(_:)",
-      "symbol_kind": "source.lang.swift.decl.function.method.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/seansmith/SeansDev/OSSSpeechKit/OSSSpeechKit/Classes/OSSSpeech.swift",
-      "line": 507,
-      "symbol": "OSSSpeech.speechRecognitionTaskFinishedReadingAudio(_:)",
-      "symbol_kind": "source.lang.swift.decl.function.method.instance",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/seansmith/SeansDev/OSSSpeechKit/OSSSpeechKit/Classes/OSSSpeechUtility.swift",
-      "line": 26,
-      "symbol": "OSSSpeechUtility",
-      "symbol_kind": "source.lang.swift.decl.class",
-      "warning": "undocumented"
-    },
-    {
-      "file": "/Users/seansmith/SeansDev/OSSSpeechKit/OSSSpeechKit/Classes/OSSUtterance.swift",
-      "line": 67,
-      "symbol": "OSSUtterance.init()",
-      "symbol_kind": "source.lang.swift.decl.function.method.instance",
-      "warning": "undocumented"
-    }
+
   ],
-  "source_directory": "/Users/seansmith/SeansDev/OSSSpeechKit"
+  "source_directory": "/Users/supermac/Developer/SeansDev/OSSSpeechKit"
 }
\ No newline at end of file