Partager via

Méthode IAudioSessionControl2 ::GetSessionInstanceIdentifier (audiopolicy.h)

  • Article

La méthode GetSessionInstanceIdentifier récupère l’identificateur de la session audio instance.

Syntaxe

HRESULT GetSessionInstanceIdentifier(
  [out] LPWSTR *pRetVal
);

Paramètres

[out] pRetVal

Pointeur vers l’adresse d’une chaîne de caractères larges terminée par null qui reçoit l’identificateur d’une instance particulière de la session audio. La chaîne est allouée par cette méthode et doit être libérée par l’appelant en appelant CoTaskMemFree. Pour plus d’informations sur CoTaskMemFree, consultez la documentation du Kit de développement logiciel (SDK) Windows.

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.

Valeur retournée Description
E_POINTER
 pRetVal a la valeur NULL.
AUDCLNT_E_DEVICE_INVALIDATED
 La session audio est déconnectée sur le périphérique audio par défaut.

Remarques

Chaque session audio instance est identifiée par une chaîne unique. Cette chaîne représente un instance particulier de la session audio et, contrairement à l’identificateur de session, est unique dans toutes les instances. Si deux instances de l’application sont en cours de lecture, elles auront des identificateurs de instance de session différents. L’identificateur récupéré par GetSessionInstanceIdentifier est différent de l’identificateur de session, qui est partagé par toutes les instances de session. Pour obtenir l’identificateur de session, appelez IAudioSessionControl2 ::GetSessionIdentifier.

GetSessionInstanceIdentifier vérifie si la session a été déconnectée sur l’appareil par défaut. Il récupère la chaîne d’identificateur mise en cache par le client audio pour l’appareil. Si l’identificateur de instance de session est introuvable, cette méthode le récupère à partir du moteur audio. Pour obtenir un exemple de code sur l’obtention d’un identificateur de instance de session, consultez Obtention d’événements de canardage à partir d’un appareil de communication.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 7 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2008 R2 [applications de bureau uniquement]
Plateforme cible Windows
En-tête audiopolicy.h

Voir aussi

IAudioSessionControl2

Utilisation d’un appareil de communication