Quick summary
Learn about the architecture of the Suki Dictation SDK and how your application, the Dictation SDK, sign-in, and Suki-hosted dictation fit together.
Architecture of the Suki Dictation SDK
The Suki Dictation SDK has four main components:- Your application
- The Suki Auth Manager
- The Dictation SDK
- The Suki hosted dictation iframe
Your app never has to build the dictation screen itself. The SDK opens that experience in the place you choose and passes results back to your code.
What each layer does
Lifecycle of a dictation session
Configure authentication
Create and configure SukiAuthManager with your partner credentials. Sign-in may run when you initialize, depending on your settings.
Create the dictation client
Create DictationClient, or use the React provider and component, tied to that auth.
Open dictation
When the user should dictate, open dictation (in-field or scratchpad). A session is active while they work.
Close dictation
When they finish or you no longer need dictation, close it. In React, unmounting the dictation UI usually closes the session for you.
For full implementation details for these APIs, refer to JavaScript integration for JavaScript, and React integration for React.