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

O método GetSessionInstanceIdentifier recupera o identificador da instância de sessão de áudio.

Sintaxe

HRESULT GetSessionInstanceIdentifier(
  [out] LPWSTR *pRetVal
);

Parâmetros

[out] pRetVal

Ponteiro para o endereço de uma cadeia de caracteres largos terminada em nulo que recebe o identificador de uma instância específica da sessão de áudio. A cadeia de caracteres é alocada por esse método e deve ser liberada pelo chamador chamando CoTaskMemFree. Para obter informações sobre CoTaskMemFree, consulte a documentação do SDK do Windows.

Retornar valor

Se o método for bem-sucedido, retornará S_OK. Se falhar, os códigos de retorno possíveis incluem, mas não se limitam a, os valores mostrados na tabela a seguir.

Valor retornado	Descrição
E_POINTER	pRetVal é NULL.
AUDCLNT_E_DEVICE_INVALIDATED	A sessão de áudio é desconectada no dispositivo de áudio padrão.

Comentários

Cada instância de sessão de áudio é identificada por uma cadeia de caracteres exclusiva. Essa cadeia de caracteres representa uma instância específica da sessão de áudio e, ao contrário do identificador de sessão, é exclusiva em todas as instâncias. Se houver duas instâncias do aplicativo em execução, elas terão identificadores de instância de sessão diferentes. O identificador recuperado por GetSessionInstanceIdentifier é diferente do identificador de sessão, que é compartilhado por todas as instâncias de sessão. Para obter o identificador de sessão, chame IAudioSessionControl2::GetSessionIdentifier.

GetSessionInstanceIdentifier verifica se a sessão foi desconectada no dispositivo padrão. Ele recupera a cadeia de caracteres do identificador armazenada em cache pelo cliente de áudio do dispositivo. Se o identificador da instância de sessão não for encontrado, esse método o recuperará do mecanismo de áudio. Por exemplo, código sobre como obter um identificador de instância de sessão, consulte Obtendo eventos de ducking de um dispositivo de comunicação.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 7 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2008 R2 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	audiopolicy.h

Confira também

IAudioSessionControl2

Usando um dispositivo de comunicação