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

  • Article

La méthode GetStreamLatency récupère la latence maximale du flux actuel et peut être appelée à tout moment après l’initialisation du flux.

Syntaxe

HRESULT GetStreamLatency(
  [out] REFERENCE_TIME *phnsLatency
);

Paramètres

[out] phnsLatency

Pointeur vers une variable REFERENCE_TIME dans laquelle la méthode écrit une valeur de temps représentant la latence. Le temps est exprimé en unités de 100 nanosecondes. Pour plus d’informations sur REFERENCE_TIME, consultez la documentation du Kit de développement logiciel (SDK) Windows.

Valeur retournée

Si la méthode réussit, retourne S_OK. En cas d’échec, les codes de retour possibles incluent, sans s’y limiter, les valeurs indiquées dans le tableau suivant.

Code de retour Description
AUDCLNT_E_NOT_INITIALIZED
 Le flux audio n’a pas été correctement initialisé.
AUDCLNT_E_DEVICE_INVALIDATED
 Le périphérique de point de terminaison audio a été débranché, ou le matériel audio ou les ressources matérielles associées ont été reconfigurés, désactivés, supprimés ou autrement rendus indisponibles.
AUDCLNT_E_SERVICE_NOT_RUNNING
 Le service audio Windows n’est pas en cours d’exécution.
E_POINTER
 Le paramètre phnsLatency est NULL.

Remarques

Cette méthode nécessite une initialisation préalable de l’interface IAudioClient . Tous les appels à cette méthode échouent avec l’erreur AUDCLNT_E_NOT_INITIALIZED jusqu’à ce que le client initialise le flux audio en appelant correctement la méthode IAudioClient ::Initialize .

Cette méthode récupère la latence maximale pour le flux actuel. La valeur ne change pas pendant la durée de vie de l’objet IAudioClient .

Les clients de rendu peuvent utiliser cette valeur de latence pour calculer la quantité minimale de données qu’ils peuvent écrire pendant n’importe quel passage de traitement. Écrire moins que ce minimum, c’est risquer d’introduire des problèmes dans le flux audio. Pour plus d’informations, consultez IAudioRenderClient ::GetBuffer.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows Vista [applications de bureau | applications UWP]
Serveur minimal pris en charge Windows Server 2008 [applications de bureau | applications UWP]
Plateforme cible Windows
En-tête audioclient.h

Voir aussi

IAudioClient, interface

IAudioClient ::Initialize

IAudioRenderClient ::GetBuffer