Release Contents
This section describes the contents of the Amazon Wake Word Engine release package.
Contents
| File/Folder | Description |
|---|---|
LICENSE.txt |
The license under which the Amazon Wake Word Engine is provided |
<arch_name> |
Folder containing binaries for a given processor architecture. A release will contain engines for one or processor architectures. See the Engines section below. |
models/ |
Folder containing models for the wake word engine in source code and binary format for all architectures |
samples/wakeword |
Sample reference data for wake word. See the section File Simulators for details on this content |
samples/fingerprinting |
Sample reference data for fingerprinting. See the section on Fingerprinting Integration for details on the content. |
samples/watermarking |
Sample reference data for watermarking. See the section on Watermarking Integration for details on the content. |
Engines
For each processor architecture provided in the release, there will be a folder at the root level with the architecture name. Inside each of these folders will be the following:
| File/Folder | Description |
|---|---|
api_sample_PRLXXXX.cpp |
Sample code demonstrating usage of the V2 (PRLXXXX) library |
pryon_lite_PRLXXXX.h |
Header file defining V2 API for wake word and other features |
pryon_lite_common_client_properties.h |
Header file defining common client properties |
pryon_lite_metadata.h |
Header file defining metadata structures |
pryon_lite_vad_PRLXXXX.h |
Header file defining VAD structures |
pryon_lite_ww.h |
Header file defining Wake Word structures |
pryon_lite_error.h |
Header file defining error codes |
PRLXXXX |
Folder containing V2 API binaries for specific PRL versions |
WakewordModelMapping.json |
Lists the models compatible with a given architecture and has the locale mapping |
wwDavsFiltersMapping.json |
Lists the sample client side Wakeword DAVS filters for a given architecture and has the locale mapping |
davs/lowpower-wakeword |
Folder containing sample client side Wakeword DAVS filters |
There may be suffixes on the above binaries (.so, .a, amazon_ww_filesim) depending on what feature set your release contains. These are customized versions of the library to minimize footprint by providing a restricted set of functionality. The table below describes the functionality of binaries with suffixes:
| Suffix | Description |
|---|---|
No suffix |
V1 API (Wake Word only). Supports all types of wake word models |
-U |
V1 API (Wake Word only). Supports "U" and "W*" type wake word models |
-PRLXXXX |
V2 API. Supports various features. See PRL Versions table for a comparison of the different PRL versions |
Models
The models folder contains subfolders with various model formats for the provided targets. These format names are used only to distinguish between the formats and have no relationship to the target or locale name. To determine what model should be used for a given locale and architecture, see the section Model Selection.
Each model will have a source code version (.cpp) and a binary (.bin) version. Depending on how your application will load the model (dynamically at run-time or statically at compile time), choose the corresponding version.