Méthode ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects (spatialaudioclient.h)

Article
08/26/2023

Place le système dans l’état où les données d’objet audio peuvent être soumises pour traitement et l’état ISpatialAudioObject peut être modifié.

Syntaxe

HRESULT BeginUpdatingAudioObjects(
  [out] UINT32 *availableDynamicObjectCount,
  [out] UINT32 *frameCountPerBuffer
);

Paramètres

[out] availableDynamicObjectCount

Nombre d’objets audio dynamiques pouvant être rendus pour le passe de traitement actuel. Tous les objets audio statiques alloués peuvent être rendus à chaque passage. Pour plus d’informations sur les types d’objets audio, consultez AudioObjectType.

[out] frameCountPerBuffer

Taille, en trames audio, de la mémoire tampon retournée par GetBuffer.

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	BeginUpdatingAudioObjects a été appelé deux fois sans appel correspondant à EndUpdatingAudioObjects entre les deux appels.
SPTLAUDCLNT_E_DESTROYED	L’ISpatialAudioClient associé au flux audio spatial a été détruit.
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_RESOURCES_INVALIDATED	Une ressource associée au flux audio spatial n’est plus valide.
SPTLAUDCLNT_E_INTERNAL	Une erreur interne s'est produite.
AUDCLNT_E_UNSUPPORTED_FORMAT	Le média associé au flux audio spatial utilise un format non pris en charge.

Remarques

Cette méthode doit être appelée chaque fois que l’événement passé dans SpatialAudioObjectRenderStreamActivationParams à ISpatialAudioClient::ActivateSpatialAudioStream est signalé,
même s’il n’y a pas de données d’objet audio à envoyer.

Pour chaque appel BeginUpdatingAudioObjects , il doit y avoir un appel correspondant à l’appel EndUpdatingAudioObjects .
Si BeginUpdatingAudioObjects est appelé deux fois sans appel EndUpdatingAudioObjects entre eux, le deuxième appel à
BeginUpdatingAudioObjects retourne SPTLAUDCLNT_E_OUT_OF_ORDER.

Configuration requise


Plateforme cible	Windows
En-tête	spatialaudioclient.h

Voir aussi

ISpatialAudioObjectRenderStream

ISpatialAudioObjectRenderStreamBase

Partager via