Méthode ISpatialAudioObjectBase ::SetEndOfStream (spatialaudioclient.h)

  • Article

Indique au système que le dernier bloc de données audio a été envoyé pour ISpatialAudioObject afin que l’objet puisse être désactivé et ses ressources réutilisées.

Syntaxe

HRESULT SetEndOfStream(
  [in] UINT32 frameCount
);

Paramètres

[in] frameCount

Nombre d’images audio dans la mémoire tampon audio qui doivent être incluses dans la passe de traitement finale. Ce nombre peut être inférieur ou égal à la valeur retournée dans le paramètre frameCountPerBuffer à ISpatialAudioObjectRenderStream ::BeginUpdatingAudioObjects.

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
SPTLAUDCLNT_E_OUT_OF_ORDER

ISpatialAudioObjectRenderStream ::BeginUpdatingAudioObjects n’a pas été appelé avant l’appel à SetEndOfStream.
SPTLAUDCLNT_E_RESOURCES_INVALIDATED

SetEndOfStream a été appelé explicitement ou implicitement dans un passe de traitement audio précédent. SetEndOfStream est appelé implicitement par le système si GetBuffer n’est pas appelé dans un passe de traitement audio (entre les appels à ISpatialAudioObjectRenderStream ::BeginUpdatingAudioObjects et ISpatialAudioObjectRenderStream ::EndUpdatingAudioObjects).

Remarques

Appelez Release après avoir appelé SetEndOfStream pour libérer les ressources d’objet audio en vue d’une utilisation ultérieure.

Configuration requise

Condition requise Valeur
Plateforme cible Windows
En-tête spatialaudioclient.h

Voir aussi

ISpatialAudioObject

ISpatialAudioObjectBase