Método IKsJackDescription::GetJackDescription (devicetopology.h)

  • Artigo

O método GetJackDescription obtém uma descrição de uma tomada de áudio.

Sintaxe

HRESULT GetJackDescription(
  [in]  UINT               nJack,
  [out] KSJACK_DESCRIPTION *pDescription
);

Parâmetros

[in] nJack

O índice de tomadas. Se a conexão consistir em n tomadas, as tomadas serão numeradas de 0 a n– 1. Para obter o número de tomadas, chame o método IKsJackDescription::GetJackCount .

[out] pDescription

Ponteiro para um buffer alocado pelo chamador no qual o método grava uma estrutura do tipo KSJACK_DESCRIPTION que contém informações sobre a tomada. O tamanho do buffer deve ser pelo menos sizeof(KSJACK_DESCRIPTION).

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.

Código de retorno Descrição
E_INVALIDARG
 O parâmetro nJack não é um índice de entrada válido.
E_POINTER
 O ponteiro pDescription é NULL.

Comentários

Quando um usuário precisa conectar um dispositivo de ponto de extremidade de áudio a uma tomada ou desconectá-lo de uma tomada, um aplicativo de áudio pode usar as informações descritivas que ele recupera desse método para ajudar o usuário a encontrar a tomada. Essas informações incluem:

  • O local físico da tomada no chassi do computador ou na caixa externa.
  • A cor da tomada.
  • O tipo de conector físico usado para a tomada.
  • O mapeamento de canais para o jack.
Para obter mais informações, consulte KSJACK_DESCRIPTION.

Requisitos

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

Confira também

IKsJackDescription Interface

IKsJackDescription::GetJackCount

KSJACK_DESCRIPTION