Skip to content

Commit f7530ae

Browse files
committed
Added implementation guide and voice activation walkthrough
1 parent 5a79526 commit f7530ae

6 files changed

+225
-56
lines changed

articles/cognitive-services/Speech-Service/toc.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -432,8 +432,10 @@
432432
items:
433433
- name: 'Start developing your assistant with Windows'
434434
href: how-to-windows-voice-assistants-get-started.md
435-
- name: 'Enable an assistant on the lock screen'
436-
href: windows-voice-assistants-implement-above-lock.md
435+
- name: 'Enable voice activation'
436+
href: windows-voice-assistants-implementation-guide.md#Implementing-Voice-Activation
437+
- name: 'Enable above lock activation'
438+
href: windows-voice-assistants-implementation-guide.md#Implementing-above-lock-activation
437439
- name: Resources
438440
items:
439441
- name: 'Explore the Windows assistant sample'

articles/cognitive-services/Speech-Service/windows-voice-assistants-best-practices.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Voice assistants developed on Windows 10 must implement the user experience guid
3030

3131
Windows 10 infers an activation experience for the customer context based on the device context. The following summary table is a high-level overview of the different views available when the screen is on.
3232

33-
| View (Availability) | Device context | Customer goal when using voice activation | Appears when | Design needs |
33+
| View (Availability) | Device context | Customer goal | Appears when | Design needs |
3434
| --- | --- | --- | --- | --- |
3535
| **In-app (19H1)** | Below lock, assistant has focus | Interact with the assistant app | Assistant processes the request in-app | Main in-app view listening experience |
3636
| **Above lock (19H2)** | Above lock, unauthenticated | Interact with the assistant, but from a distance | System is locked and assistant requests activation | Full-screen visuals for far-field UI. Implement dismissal policies to not block unlock. |
@@ -76,6 +76,9 @@ When the assistant app has focus, the customer intent is clearly to interact wit
7676

7777
Available with 19H2, assistants built on Windows voice activation platform are available to answer above lock.
7878

79+
> [!NOTE]
80+
> Due to an active issue, assistants that draw above lock UI must implement WindowService.CloseWindow() for all dismissals. This will result in app termination, but mitigates a technical issue and keeps the assistant in a clean state. Furthermore, to maintain clean state if an app is enabled for above lock voice activation, it must listen for lock state changes and WindowService.CloseWindow() when the device locks.
81+
7982
### Customer opt-in
8083

8184
Voice activation above lock is always disabled by default. Customers opt-in through the Windows settings>Privacy>Voice Activation. For details on monitoring and prompting for this setting, see the [above lock implementation guide](windows-voice-assistants-implement-above-lock#Detect-user-preference).
@@ -88,7 +91,7 @@ While notifications or other standard app lock-screen integration points remain
8891

8992
### Above lock experience following voice activation
9093

91-
When the screen is on, the assistant app is full screen with no title bar above the lock screen. Larger visuals and strong voice descriptions with strong VUI allow for cases where the customer is too far away to read UI or has their hands busy with another (non-PC) task.
94+
When the screen is on, the assistant app is full screen with no title bar above the lock screen. Larger visuals and strong voice descriptions with strong voice-primary interface allow for cases where the customer is too far away to read UI or has their hands busy with another (non-PC) task.
9295

9396
When the screen remains off, the assistant app could play an earcon to indicate the assistant is activating and provide a voice-only experience.
9497

@@ -153,6 +156,11 @@ The Contoso assistant has a home on the taskbar: their swirling, circular icon.
153156

154157
![Screenshot of voice assistant on Windows replying in compact view](media/voice-assistants/windows_voice_assistant/compact_view_response.png)
155158

156-
**Hand-off**. At any point, the assistant may handoff to its main app view to provide more information or answers or dialogue that require more screen real estate. Please refer [here](windows-voice-assistants-faq#My-app-is-showing-in-a-small-window-when-I-activate-it-by-voice.-How-can-I-transition-from-the-compact-view-to-a-full-application-window) for implementation details.
159+
**Hand-off**. At any point, the assistant may handoff to its main app view to provide more information or answers or dialogue that require more screen real estate. Please refer to the [Transition from compact view to full view](windows-voice-assistants-implementation-guide#Transition-from-compact-view-to-full-view) section for implementation details.
160+
161+
![Screenshots of voice assistant on Windows before and after expanding the compact view](media/voice-assistants/windows_voice_assistant/compact_transition.png)
162+
163+
## Next steps
157164

158-
![Screenshots of voice assistant on Windows before and after exapanding the compact view](media/voice-assistants/windows_voice_assistant/compact_transition.png)
165+
> [!div class="nextstepaction"]
166+
> [Learn about the process of voice activation](windows-voice-assistants-voice-activation.md)

articles/cognitive-services/Speech-Service/windows-voice-assistants-faq.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,23 @@ ms.author: travisw
1515

1616
# Frequently asked questions
1717

18-
## General
18+
## How do I contact Microsoft for resources like Limited Access Feature tokens and keyword model files?
1919

20-
### How do I contact Microsoft for resources like Limited Access Feature tokens and 1st stage keyword model files?
2120

2221

23-
## Implementation
24-
25-
### My app is showing in a small window when I activate it by voice. How can I transition from the compact view to a full application window?
22+
## My app is showing in a small window when I activate it by voice. How can I transition from the compact view to a full application window?
2623

2724
When your application is first activated by voice, it is started in a compact view. Please read the [Design guidance for voice activation preview](windows-voice-assistants-best-practices#Design-guidance-for-voice-activation-preview) for guidance on the different views and transitions between them for voice assistants on Windows.
2825

29-
To make the transition from compact view to full app view, use the appView API TryEnterViewModeAsync:
30-
31-
var appView = ApplicationView.GetForCurrentView();
32-
await appView.TryEnterViewModeAsync(ApplicationViewMode.Default);
26+
To make the transition from compact view to full app view, use the appView API `TryEnterViewModeAsync`:
3327

34-
### Do I have to make my voice assistant a UWP application?
28+
`var appView = ApplicationView.GetForCurrentView();
29+
await appView.TryEnterViewModeAsync(ApplicationViewMode.Default);`
3530

36-
### Do I have to use Direct Line Speech for my Windows Conversational Agent?
31+
## Why are voice assistant features on Windows only enabled for UWP applications?
3732

38-
The UWP Sample Application was developed using Direct Line Speech and the Speech Services SDK as a demonstration of how to use a dialog service with the Windows Conversational Agent capability. However, you can use any service for local and cloud keyword verification, speech-to-text conversion, bot dialog, and text-to-speech conversion. See how in the [UWP Sample Application docs]().
33+
Given the privacy risks associated with features like voice activation, the features of the UWP platform are necessary allow the voice assistant features on Windows to be sufficiently secure.
3934

40-
## Design
35+
## The UWP Voice Assistant Sample uses Direct Line Speech. Do I have to use Direct Line Speech for my voice assistant on Windows?
4136

42-
## Issues
37+
The UWP Sample Application was developed using Direct Line Speech and the Speech Services SDK as a demonstration of how to use a dialog service with the Windows Conversational Agent capability. However, you can use any service for local and cloud keyword verification, speech-to-text conversion, bot dialog, and text-to-speech conversion.

articles/cognitive-services/Speech-Service/windows-voice-assistants-implement-above-lock.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

0 commit comments

Comments
 (0)