https://github.com/mideind/emblacoreflutter
Embla core session functionality in the form of a Flutter library.
https://github.com/mideind/emblacoreflutter
dart flutter flutter-package icelandic icelandic-language mobile-app voice-assistant
Last synced: 3 months ago
JSON representation
Embla core session functionality in the form of a Flutter library.
- Host: GitHub
- URL: https://github.com/mideind/emblacoreflutter
- Owner: mideind
- License: gpl-3.0
- Created: 2022-09-06T16:58:25.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-07T16:29:29.000Z (over 1 year ago)
- Last Synced: 2026-02-16T14:10:06.447Z (4 months ago)
- Topics: dart, flutter, flutter-package, icelandic, icelandic-language, mobile-app, voice-assistant
- Language: Dart
- Homepage: https://embla.is/embla_core/
- Size: 2.93 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/gpl-3.0)
[]()
[]()
# EmblaCore
EmblaCore is a [Flutter](https://flutter.dev/) library containing the core session
functionality in [Embla](https://github.com/mideind/EmblaFlutterApp), a cross-platform
mobile Icelandic-language voice assistant app. EmblaCore requires Flutter >= 3.0.0.
For the corresponding JavaScript library, see [EmblaCoreJS](https://github.com/mideind/EmblaCoreJS).
## Installation
EmblaCore is available via [pub.dev](https://pub.dev/packages/embla_core).
Add this to the dependencies list in your `pubspec.yaml` file:
```yaml
embla_core: "^1.0.10"
```
and then run the following command from the project root:
```bash
flutter pub get
```
EmblaCore uses the [Flutter Sound](https://pub.dev/packages/flutter_sound)
plugin to record audio. In order to work, iOS apps making use of this package
must add the following to their `Info.plist` file:
```xml
NSMicrophoneUsageDescription
Microphone permission is required for speech recognition.
```
Android apps must have the following in their `AndroidManifest.xml` file:
```xml
```
The app must also explicitly request permission to record audio from the user. This can
be done using the [permission_handler](https://pub.dev/packages/permission_handler)
package, for instance.
You should run the following code early in your app before starting an Embla session:
```dart
EmblaSession.prepare();
```
This preloads audio files into memory and configures the audio session appropriately.
## Documentation
Extensive `dartdoc` documentation is [available here](https://embla.is/embla_core).
## Demo App
A simple demo app that demonstrates how to use EmblaCore can viewed at
[`example/lib/main.dart`](https://github.com/mideind/EmblaCoreFlutter/blob/master/example/lib/main.dart).
To run the demo app, you must acquire an API key from [Mideind](https://mideind.is) and add
it in the file `example/lib/main.dart`. Then run the following command from the repo root:
```bash
cd example
flutter run -d [your_device_id]
```
## Basic API usage
```dart
import 'package:embla_core/embla_core.dart';
...
var config = EmblaSessionConfig();
/* Set properties of config object... */
var session = EmblaSession(config=config);
session.start();
...
session.cancel();
```
## License
EmblaCore is Copyright © 2023-2025 [Miðeind ehf.](https://mideind.is)
This set of programs is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any later
version.
This set of programs is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
The full text of the GNU General Public License v3 is
[included here](https://github.com/mideind/EmblaCoreFlutter/raw/master/LICENSE)
and also available here:
[https://www.gnu.org/licenses/gpl-3.0.html](https://www.gnu.org/licenses/gpl-3.0.html).
If you wish to use this set of programs in ways that are not covered under the
GNU GPLv3 license, please contact us at [mideind@mideind.is](mailto:mideind@mideind.is)
to negotiate a custom license. This applies for instance if you want to include or use
this software, in part or in full, in other software that is not licensed under
GNU GPLv3 or other compatible licenses.