Método IAudioClient::GetStreamLatency (audioclient.h)

O método GetStreamLatency recupera a latência máxima para o fluxo atual e pode ser chamado a qualquer momento após a inicialização do fluxo.

Sintaxe

HRESULT GetStreamLatency(
  [out] REFERENCE_TIME *phnsLatency
);

Parâmetros

[out] phnsLatency

Ponteiro para uma variável REFERENCE_TIME na qual o método grava um valor de tempo que representa a latência. O tempo é expresso em unidades de 100 nanossegundos. Para obter mais informações sobre REFERENCE_TIME, 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.

Código de retorno	Descrição
AUDCLNT_E_NOT_INITIALIZED	O fluxo de áudio não foi inicializado com êxito.
AUDCLNT_E_DEVICE_INVALIDATED	O dispositivo de ponto de extremidade de áudio foi desconectado ou o hardware de áudio ou os recursos de hardware associados foram reconfigurados, desabilitados, removidos ou não estão disponíveis para uso.
AUDCLNT_E_SERVICE_NOT_RUNNING	O serviço de áudio do Windows não está em execução.
E_POINTER	O parâmetro phnsLatency é NULL.

Comentários

Esse método requer a inicialização prévia da interface IAudioClient . Todas as chamadas para esse método falharão com o erro AUDCLNT_E_NOT_INITIALIZED até que o cliente inicialize o fluxo de áudio chamando com êxito o método IAudioClient::Initialize .

Esse método recupera a latência máxima para o fluxo atual. O valor não será alterado durante o tempo de vida do objeto IAudioClient .

Os clientes de renderização podem usar esse valor de latência para calcular a quantidade mínima de dados que podem ser gravados durante qualquer passagem de processamento único. Escrever menos do que esse mínimo é correr o risco de introduzir falhas no fluxo de áudio. Para obter mais informações, consulte IAudioRenderClient::GetBuffer.

Requisitos

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

Confira também

IAudioClient Interface

IAudioClient::Initialize

IAudioRenderClient::GetBuffer