Méthode ISpatialAudioObjectRenderStream ::ActivateSpatialAudioObject (spatialaudioclient.h)

Article
03/02/2024

Active un ISpatialAudioObject pour le rendu audio.

Syntaxe

HRESULT ActivateSpatialAudioObject(
  [in]  AudioObjectType     type,
  [out] ISpatialAudioObject **audioObject
);

Paramètres

[in] type

Type d’objet audio à activer. Pour les objets audio dynamiques, cette valeur doit être AudioObjectType_Dynamic. Pour les objets audio statiques, spécifiez l’une des valeurs de canal audio statique de l’énumération. La spécification de AudioObjectType_None génère un objet audio qui n’est pas spatialisé.

[out] audioObject

Reçoit un pointeur vers l’interface activée.

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_NO_MORE_OBJECTS	Le système a atteint le nombre maximal d’objets audio simultanés.
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.
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

Un ISpatialAudioObject dynamique est un objet qui a été activé en définissant le paramètre type sur la méthode ActivateSpatialAudioObject sur AudioObjectType_Dynamic. Le client a une limite du nombre maximal d’objets audio spatiaux dynamiques qui peuvent être activés à la fois. Une fois la limite atteinte, la tentative d’activation d’objets audio supplémentaires entraîne le renvoi d’une erreur SPTLAUDCLNT_E_NO_MORE_OBJECTS par cette méthode. Pour éviter cela, appelez Release sur chaque ISpatialAudioObject dynamique une fois qu’il n’est plus utilisé pour libérer la ressource afin qu’elle puisse être réaffectée. Pour plus d’informations sur la gestion de la durée de vie des objets audio spatiaux, consultez ISpatialAudioObject ::IsActive et ISpatialAudioObject ::SetEndOfStream .

Configuration requise

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

Voir aussi

ISpatialAudioObjectRenderStream

Partager via