Метод IAudioClient::GetStreamLatency (audioclient.h)

Метод GetStreamLatency извлекает максимальную задержку для текущего потока и может вызываться в любое время после инициализации потока.

Синтаксис

HRESULT GetStreamLatency(
  [out] REFERENCE_TIME *phnsLatency
);

Параметры

[out] phnsLatency

Указатель на переменную REFERENCE_TIME , в которую метод записывает значение времени, представляющее задержку. Время выражается в 100-наносекундных единицах. Дополнительные сведения о REFERENCE_TIME см. в документации по windows SDK.

Возвращаемое значение

Если метод завершается успешно, возвращает значение S_OK. В случае сбоя возможные коды возврата включают, помимо прочего, значения, показанные в следующей таблице.

Код возврата	Описание
AUDCLNT_E_NOT_INITIALIZED	Аудиопоток не инициализирован.
AUDCLNT_E_DEVICE_INVALIDATED	Устройство конечной точки аудио отключено, звуковое оборудование или связанные аппаратные ресурсы были перенастроены, отключены, удалены или иным образом недоступны для использования.
AUDCLNT_E_SERVICE_NOT_RUNNING	Служба звука Windows не запущена.
E_POINTER	Параметр phnsLatency имеет значение NULL.

Комментарии

Этот метод требует предварительной инициализации интерфейса IAudioClient . Все вызовы этого метода будут завершаться ошибкой AUDCLNT_E_NOT_INITIALIZED до тех пор, пока клиент не инициализирует аудиопоток, вызвав метод IAudioClient::Initialize .

Этот метод извлекает максимальную задержку для текущего потока. Значение не изменится в течение времени существования объекта IAudioClient .

Клиенты отрисовки могут использовать это значение задержки, чтобы вычислить минимальный объем данных, которые они могут записать в течение любого одного этапа обработки. Чтобы написать меньше этого минимума, вы рискуете ввести сбои в аудиопоток. Дополнительные сведения см. в разделе IAudioRenderClient::GetBuffer.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [классические приложения | Приложения UWP]
Минимальная версия сервера	Windows Server 2008 [классические приложения | Приложения UWP]
Целевая платформа	Windows
Header	audioclient.h

См. также раздел

Интерфейс IAudioClient

IAudioClient::Initialize

IAudioRenderClient::GetBuffer