Skip to content
This repository has been archived by the owner on May 6, 2022. It is now read-only.

Commit

Permalink
improve keyword profile documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
space-pope committed Mar 9, 2021
1 parent b1583c1 commit 28f1c69
Showing 1 changed file with 27 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,33 @@

/**
* A speech pipeline profile that uses voice activity detection to activate
* ASR based on keyword detection.
* ASR based on keyword detection. In other words, any speech will cause the
* pipeline to activate, and {@code KeywordRecognizer} acts as the ASR
* component, only transcribing utterances contained in its vocabulary.
*
* <p>
* The activation period ends either:
*
* <ul>
* <li>
* when speech stops, as determined by {@code VoiceActivityDetector}'s
* configuration, or
* </li>
* <li>
* when the activation period exceeds the timeout configured in
* {@code ActivationTimeout}
* </li>
* </ul>
*
* <p>
* If no valid keyword is detected during the activation period, a timeout
* event will be dispatched.
* </p>
*
* <p>
* The components in this profile process speech entirely on the local device;
* no cloud components are involved.
* </p>
*
* <p>
* The keyword detector requires extra configuration, which must be
Expand Down

0 comments on commit 28f1c69

Please sign in to comment.