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

El método GetSessionInstanceIdentifier recupera el identificador de la instancia de sesión de audio.

Sintaxis

HRESULT GetSessionInstanceIdentifier(
  [out] LPWSTR *pRetVal
);

Parámetros

[out] pRetVal

Puntero a la dirección de una cadena de caracteres anchos terminada en NULL que recibe el identificador de una instancia determinada de la sesión de audio. El autor de la llamada asigna la cadena mediante este método y debe liberarla llamando a CoTaskMemFree. Para obtener información sobre CoTaskMemFree, consulte la documentación de Windows SDK.

Valor devuelto

Si el método se realiza correctamente, devuelve S_OK. Si se produce un error, los códigos de retorno posibles incluyen, entre otros, los valores que se muestran en la tabla siguiente.

Valor devuelto	Descripción
E_POINTER	pRetVal es NULL.
AUDCLNT_E_DEVICE_INVALIDATED	La sesión de audio se desconecta en el dispositivo de audio predeterminado.

Comentarios

Cada instancia de sesión de audio se identifica mediante una cadena única. Esta cadena representa una instancia determinada de la sesión de audio y, a diferencia del identificador de sesión, es única en todas las instancias. Si hay dos instancias de la aplicación que se reproducen, tendrán identificadores de instancia de sesión diferentes. El identificador recuperado por GetSessionInstanceIdentifier es diferente del identificador de sesión, que comparte todas las instancias de sesión. Para obtener el identificador de sesión, llame a IAudioSessionControl2::GetSessionIdentifier.

GetSessionInstanceIdentifier comprueba si la sesión se ha desconectado en el dispositivo predeterminado. Recupera la cadena de identificador almacenada en caché por el cliente de audio para el dispositivo. Si no se encuentra el identificador de la instancia de sesión, este método lo recupera del motor de audio. Para obtener código de ejemplo sobre cómo obtener un identificador de instancia de sesión, consulte Getting Ducking Events from a Communication Device.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 7 [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 R2 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	audiopolicy.h

Consulte también

IAudioSessionControl2

Uso de un dispositivo de comunicación