Méthode IAudioSessionControl::SetGroupingParam (audiopolicy.h)

Article
08/22/2023

La méthode SetGroupingParam affecte une session à un regroupement de sessions.

Syntaxe

HRESULT SetGroupingParam(
  [in] LPCGUID Override,
  [in] LPCGUID EventContext
);

Paramètres

[in] Override

Nouveau paramètre de regroupement. Ce paramètre doit être un pointeur non NULL valide vers un GUID de paramètre de regroupement. Pour plus d'informations, consultez la section Notes.

[in] EventContext

Pointeur vers le GUID de contexte d’événement. Si un appel à cette méthode génère un événement grouping-change, le gestionnaire de sessions envoie des notifications à tous les clients qui ont inscrit des interfaces IAudioSessionEvents avec le gestionnaire de sessions. Le gestionnaire de session inclut la valeur du pointeur EventContext à chaque notification. Lors de la réception d’une notification, un client peut déterminer s’il ou un autre client est la source de l’événement en inspectant la valeur EventContext . Ce schéma dépend de la sélection par le client d’une valeur pour ce paramètre qui est unique parmi tous les clients de la session. Si l’appelant fournit un pointeur NULL pour ce paramètre, la méthode de notification du client reçoit un pointeur de contexte NULL .

Valeur retournée

Si la méthode réussit, retourne S_OK. En cas d’échec, les codes de retour possibles incluent, sans s’y limiter, les valeurs indiquées dans le tableau suivant.

Code de retour	Description
E_POINTER	Le regroupement de paramètres a lavaleur NULL.
AUDCLNT_E_DEVICE_INVALIDATED	Le périphérique de point de terminaison audio a été débranché, ou le matériel audio ou les ressources matérielles associées ont été reconfigurés, désactivés, supprimés ou autrement indisponibles.
AUDCLNT_E_SERVICE_NOT_RUNNING	Le service audio Windows n’est pas en cours d’exécution.

Remarques

Un client appelle cette méthode pour modifier le paramètre de regroupement d’une session. Toutes les sessions audio qui ont la même valeur de paramètre de regroupement sont sous le contrôle du même curseur au niveau du volume dans le programme de contrôle du volume système, Sndvol. Pour plus d’informations, consultez Paramètres de regroupement.

Le client peut obtenir le paramètre de regroupement actuel de la session en appelant la méthode IAudioSessionControl::GetGroupingParam .

Si un client n’a jamais appelé SetGroupingParam pour affecter un paramètre de regroupement à une session, la session n’appartient à aucun regroupement. Une session qui n’appartient à aucun regroupement a son propre curseur de niveau volume dédié dans le programme Sndvol.

Configuration requise


Client minimal pris en charge	Windows Vista [applications de bureau \| applications UWP]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau \| applications UWP]
Plateforme cible	Windows
En-tête	audiopolicy.h

Voir aussi

IAudioSessionControl, interface

IAudioSessionControl::GetGroupingParam

IAudioSessionEvents Interface

Partager via