Skip to content

Commit 34861f9

Browse files
Updated Input Readme
Added KeywordManager depreciation marking. Updated SpeechInputSource and SpeechInputHandler documentation.
1 parent cc064ec commit 34861f9

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

Assets/HoloToolkit/Input/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -196,22 +196,26 @@ or in your Visual Studio Package.appxmanifest capabilities.
196196
Edit -> Project Settings -> Player -> Settings for Windows Store -> Publishing Settings -> Capabilities
197197
or in your Visual Studio Package.appxmanifest capabilities.
198198

199-
##### KeywordManager.cs
199+
##### KeywordManager.cs (_Depreciated_)
200+
Please use SpeechInputSource and SpeechInputHandler instead.
200201
Allows you to specify keywords and methods in the Unity Inspector, instead of registering them explicitly in code.
201202

202203
**_KeywordsAndResponses_** Set the size as the number of keywords you'd like to listen for, then specify the keywords and method responses to complete the array.
203204

204205
**RecognizerStart** Set this to determine whether the keyword recognizer will start immediately or if it should wait for your code to tell it to start.
205206

206207
##### SpeechInputSource.cs
207-
Allows you to specify keywords and keyboard shortcuts in the Unity Inspector, instead of registering them explicitly in code. Keywords are handled by scripts that implement ISpeechHandler.cs.
208+
Allows you to specify keywords and keyboard shortcuts in the Unity Inspector, instead of registering them explicitly in code. Keywords are handled by scripts that implement ISpeechHandler.cs. You can utilize keywords with the SpeechInputHandler component by assigning game objects and specifying a Unity Event trigger.
208209

209210
Check out Assets/HoloToolkit/Input/Tests/Scripts/SphereKeywords.cs and Assets/HoloToolkit/Input/Tests/Scripts/SphereGlobalKeywords.cs for an example of implementing these features, which is used in the demo scene at Assets/HoloToolkit/Input/Tests/SpeechInputSource.unity.
210211

211212
**_KeywordsAndKeys_** Set the size as the number of keywords you'd like to listen for, then specify the keywords to complete the array.
212213

213214
**RecognizerStart** Set this to determine whether the keyword recognizer will start immediately or if it should wait for your code to tell it to start.
214215

216+
##### SpeechInputHandler.cs
217+
Used to assign a Unity Event to a keyword stored in the SpeechInputSource
218+
215219
##### ISpeechHandler.cs
216220
Interface that a game object can implement to react to speech keywords.
217221

0 commit comments

Comments
 (0)