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

Article
08/22/2023

La méthode SetIconPath affecte une icône d’affichage à la session active.

Syntaxe

HRESULT SetIconPath(
  [in] LPCWSTR Value,
  [in] LPCGUID EventContext
);

Paramètres

[in] Value

Pointeur vers une chaîne de caractères larges terminée par null qui spécifie le chemin d’accès et le nom de fichier d’un fichier .ico, .dll ou .exe qui contient l’icône. Pour plus d’informations sur les chemins d’accès aux icônes, consultez la documentation du Kit de développement logiciel (SDK) Windows.

[in] EventContext

Pointeur vers le GUID de contexte d’événement. Si un appel à cette méthode génère un événement de modification d’icône, le gestionnaire de session envoie des notifications à tous les clients qui ont inscrit des interfaces IAudioSessionEvents avec le gestionnaire de sessions. Le gestionnaire de sessions 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 du fait que le client sélectionne 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	La valeur du paramètre est 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 rendus indisponibles.
AUDCLNT_E_SERVICE_NOT_RUNNING	Le service audio Windows n’est pas en cours d’exécution.

Remarques

Dans Windows Vista, le programme fourni par le système, Sndvol.exe, utilise l’icône d’affichage (ainsi que le nom complet) pour étiqueter le contrôle de volume de la session. Si le client n’appelle pas SetIconPath pour affecter une icône à la session, le programme Sndvol utilise l’icône de la fenêtre d’application comme icône par défaut pour la session.

Dans le cas d’une session inter-processus, la session n’est pas associée à un seul processus d’application. Par conséquent, Sndvol n’a pas d’icône spécifique à l’application à utiliser par défaut, et le client doit appeler SetIconPath pour éviter d’afficher une icône sans signification.

L’icône d’affichage ne persiste pas au-delà de la durée de vie de l’objet IAudioSessionControl . Par conséquent, une fois toutes les références à l’objet libérées, une version créée par la suite de l’objet (avec la même application, le même GUID de session et le même appareil de point de terminaison) aura à nouveau une icône par défaut jusqu’à ce que le client appelle SetIconPath.

Le client peut récupérer l’icône d’affichage de la session en appelant la méthode IAudioSessionControl::GetIconPath .

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::GetIconPath

Share via