Partager via

Méthode IAudioClient3 ::GetSharedModeEnginePeriod (audioclient.h)

  • Article

Retourne la plage de périodicités prises en charge par le moteur pour le format de flux spécifié. La périodicité du moteur est la vitesse à laquelle le moteur réveille un client audio piloté par les événements pour transférer des données audio vers ou depuis le moteur. Les valeurs retournées dépendent des caractéristiques du client audio spécifiées lors d’un appel précédent à IAudioClient2 ::SetClientProperties.

Syntaxe

HRESULT GetSharedModeEnginePeriod(
  [in]  const WAVEFORMATEX *pFormat,
  [out] UINT32             *pDefaultPeriodInFrames,
  [out] UINT32             *pFundamentalPeriodInFrames,
  [out] UINT32             *pMinPeriodInFrames,
  [out] UINT32             *pMaxPeriodInFrames
);

Paramètres

[in] pFormat

Type : const WAVEFORMATEX*

Format de flux pour lequel les périodicités prises en charge sont interrogées.

[out] pDefaultPeriodInFrames

Type : UINT32*

Période par défaut pendant laquelle le moteur réveille le client pour le transfert d’exemples audio

[out] pFundamentalPeriodInFrames

Type : UINT32*

Période de base pendant laquelle le moteur réveille le client pour le transfert d’exemples audio. Lorsque vous définissez la périodicité du moteur audio, vous devez utiliser un multiple intégral de cette valeur.

[out] pMinPeriodInFrames

Type : UINT32*

Période la plus courte, dans les images audio, avec laquelle le moteur audio réveille le client pour le transfert d’échantillons audio.

[out] pMaxPeriodInFrames

Type : UINT32*

Période la plus longue, dans les images audio, avec laquelle le moteur audio réveille le client pour le transfert d’échantillons audio.

Valeur retournée

Type : HRESULT

Cette méthode retourne S_OK pour indiquer qu’elle s’est terminée avec succès. Sinon, il retourne un code d’erreur approprié.

Remarques

Les clients audio demandent une périodicité spécifique du moteur audio avec le paramètre PeriodInFrames à IAudioClient3 ::InitializeSharedAudioStream. La valeur de PeriodInFrames doit être un multiple intégral de la valeur retournée dans le paramètre pFundamentalPeriodInFrames . PeriodInFrames doit également être supérieur ou égal à la valeur retournée dans pMinPeriodInFrames et inférieur ou égal à la valeur de pMaxPeriodInFrames.

Par exemple, pour un format 44100 kHz, GetSharedModeEnginePeriod peut retourner :

  • pDefaultPeriodInFrames = 448 images (environ 10,16 millisecondes)

  • pFundamentalPeriodInFrames = 4 images (environ 0,09 millisecondes)

  • pMinPeriodInFrames = 48 images (environ 1,09 millisecondes)

  • pMaxPeriodInFrames = 448 images (identique à la valeur par défaut)

Les valeurs autorisées pour le paramètre PeriodInFrames à InitializeSharedAudioStream incluent 48 et 448. Ils incluraient également des éléments tels que 96 et 128.

Ils n’incluraient PAS 4 (qui est plus petit que la valeur minimale autorisée) ou 98 (qui n’est pas un multiple de la valeur fondamentale) ou 1000 (qui est plus grand que la valeur maximale autorisée).

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 10 (applications de bureau uniquement)
Serveur minimal pris en charge Windows Server 2016 (applications de bureau uniquement)
Plateforme cible Windows
En-tête audioclient.h

Voir aussi

IAudioClient3