ConversationalAgentSession Classe

Définition

Espace de noms:

Windows.ApplicationModel.ConversationalAgent

Canal de communication entre le assistant numérique et la plateforme de l’agent conversationnel Windows.

public ref class ConversationalAgentSession sealed : IClosable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 524288)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ConversationalAgentSession final : IClosable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 524288)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ConversationalAgentSession : System.IDisposable

Public NotInheritable Class ConversationalAgentSession
Implements IDisposable

Héritage

Object Platform::Object IInspectable ConversationalAgentSession

Attributs

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implémente

IClosable IDisposable

Configuration requise pour Windows

Famille d’appareils	Windows 10, version 1903 (introduit dans 10.0.18362.0)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v8.0)

Remarques

ConversationalAgentSession est généralement créé via l’activation vocale lorsqu’un énoncé mot clé tel que « Hey Cortana » ou « Alexa » est reconnu.

Une ConversationalAgentSession peut être créée de différentes façons, notamment en Bluetooth (lorsqu’un énoncé mot clé est transmis via un casque ou un microphone), des raccourcis clavier système (comme Win+C pour Cortana) et l’initiation d’interactions vocales à partir de votre application (peut-être par le biais d’une sorte d’interface utilisateur press-to-talk).

Propriétés

AgentState	Obtient l’état de la assistant numérique.
IsIndicatorLightAvailable	Obtient si le voyant lumineux est disponible.
IsInterrupted	Obtient si conversationalAgentSession est interrompu.
IsInterruptible	Obtient si conversationalAgentSession peut être interrompu.
IsScreenAvailable	Obtient si l’écran peut être activé.
IsUserAuthenticated	Obtient si l’utilisateur est authentifié (par exemple, l’appareil est verrouillé).
IsVoiceActivationAvailable	Obtient si la assistant numérique peut être activée par l’entrée vocale.
Signal	Signal qui a activé le assistant numérique, comme un énoncé mot clé, la transmission Bluetooth, l’accélérateur clavier système, la reconnaissance vocale dans l’application ou d’autres sons (claquement de porte, détecteur de fumée).

Méthodes

Close()	Met fin à ConversationalAgentSession.
CreateAudioDeviceInputNode(AudioGraph)	Crée de façon synchrone un nœud d’entrée de graphique audio. Important Pour éviter d’éventuels problèmes d’accès concurrentiel, nous vous recommandons d’utiliser CreateAudioDeviceInputNodeAsync à la place.
CreateAudioDeviceInputNodeAsync(AudioGraph)	Crée de façon asynchrone un nœud d’entrée de graphique audio.
Dispose()	Exécute les tâches définies par l'application associées à la libération ou à la redéfinition des ressources non managées.
GetAudioCaptureDeviceId()	Récupère de façon synchrone l’ID de l’appareil d’entrée vocale actuel. Important Pour éviter d’éventuels problèmes d’accès concurrentiel, nous vous recommandons d’utiliser GetAudioCaptureDeviceIdAsync à la place.
GetAudioCaptureDeviceIdAsync()	Récupère de façon asynchrone l’ID de l’appareil d’entrée vocale actuel.
GetAudioClient()	Récupère de façon synchrone un objet IAudioClient qui crée et initialise un flux audio entre votre application et le périphérique de rendu audio. Important Pour éviter d’éventuels problèmes d’accès concurrentiel, nous vous recommandons d’utiliser GetAudioClientAsync à la place.
GetAudioClientAsync()	Récupère de façon asynchrone un objet IAudioClient qui crée et initialise un flux audio entre votre application et le périphérique de rendu audio.
GetAudioRenderDeviceId()	Récupère de façon synchrone l’ID de l’appareil de sortie vocale actuel. Important Pour éviter d’éventuels problèmes d’accès concurrentiel, nous vous recommandons d’utiliser GetAudioRenderDeviceIdAsync à la place.
GetAudioRenderDeviceIdAsync()	Récupère de manière asynchrone l’ID de l’appareil de sortie vocale actuel.
GetCurrentSessionAsync()	Récupère de manière asynchrone une référence à la ConversationalAgentSession actuelle.
GetCurrentSessionSync()	Récupère de façon synchrone une référence à la ConversationalAgentSession actuelle. Important Pour éviter d’éventuels problèmes d’accès concurrentiel, nous vous recommandons d’utiliser GetCurrentSessionAsync à la place.
GetMissingPrerequisites()	Obtient les prérequis manquants requis pour que l’activation vocale devienne disponible et fonctionne correctement.
GetMissingPrerequisitesAsync()	Obtient les prérequis manquants pour que l’activation vocale devienne disponible et fonctionne correctement.
GetSignalModelId()	Récupère l’identificateur de modèle unique du signal qui a activé l’agent conversationnel. Important Pour éviter d’éventuels problèmes d’accès concurrentiel, nous vous recommandons d’utiliser GetSignalModelIdAsync à la place.
GetSignalModelIdAsync()	Récupère de manière asynchrone l’identificateur de modèle unique du signal qui a activé l’agent conversationnel.
GetSupportedSignalModelIds()	Récupère la collection d’identificateurs de modèle signal uniques pris en charge par l’agent conversationnel. Important Pour éviter d’éventuels problèmes d’accès concurrentiel, nous vous recommandons d’utiliser GetSupportedSignalModelIdsAsync à la place.
GetSupportedSignalModelIdsAsync()	Récupère de manière asynchrone la collection d’identificateurs de modèle signal uniques pris en charge par l’agent conversationnel.
RequestActivation(ConversationalAgentActivationKind)	Demande que le assistant numérique soit activé au premier plan.
RequestActivationAsync(ConversationalAgentActivationKind)	Demande de manière asynchrone que le assistant numérique soit activé au premier plan.
RequestAgentStateChange(ConversationalAgentState)	Demande de façon synchrone un changement d’état pour la ConversationalAgentSession actuelle. Important Pour éviter d’éventuels problèmes d’accès concurrentiel, nous vous recommandons d’utiliser RequestAgentStateChangeAsync à la place.
RequestAgentStateChangeAsync(ConversationalAgentState)	Demande de façon asynchrone un changement d’état pour la ConversationalAgentSession actuelle.
RequestForegroundActivation()	Demande de manière synchrone que le assistant numérique soit activé au premier plan. Important Pour éviter d’éventuels problèmes d’accès concurrentiel, nous vous recommandons d’utiliser RequestForegroundActivationAsync à la place.
RequestForegroundActivationAsync()	Demande de manière asynchrone que le assistant numérique soit activé au premier plan.
RequestInterruptible(Boolean)	Demande de façon synchrone que cette ConversationalAgentSession soit interruptible si l’mot clé pour une autre assistant numérique est détectée. Important Pour éviter d’éventuels problèmes d’accès concurrentiel, nous vous recommandons d’utiliser RequestInterruptibleAsync à la place.
RequestInterruptibleAsync(Boolean)	Demande de façon asynchrone que cette ConversationalAgentSession soit interruptible si l’mot clé d’une autre assistant numérique est détectée.
SetSignalModelId(UInt32)	Affecte un identificateur unique au modèle représentant le signal audio d’activation pour l’agent conversationnel. Important Pour éviter d’éventuels problèmes d’accès concurrentiel, nous vous recommandons d’utiliser SetSignalModelIdAsync à la place.
SetSignalModelIdAsync(UInt32)	Affecte de façon asynchrone un identificateur unique au modèle représentant le signal audio d’activation pour l’agent conversationnel.
SetSupportLockScreenActivation(Boolean)	Active ou désactive la prise en charge de l’activation de l’écran de verrouillage de l’agent conversationnel.
SetSupportLockScreenActivationAsync(Boolean)	Active ou désactive de façon asynchrone la prise en charge de l’activation de l’écran de verrouillage de l’agent conversationnel.

Événements

SessionInterrupted	Se produit lorsqu’un autre signal d’activation de assistant numérique a été détecté.
SignalDetected	Se produit lorsqu’un signal d’activation d’un assistant numérique est détecté.
SystemStateChanged	Se produit lorsque le système ou l’utilisateur modifie un paramètre qui limite la capacité de l’assistant numérique à effectuer une ou plusieurs actions.