IXAudio2SourceVoice::Stop, méthode (xaudio2.h)

Article
08/28/2023

Arrête la consommation audio par la voix actuelle.

Syntaxe

HRESULT Stop(
  [in] UINT32 Flags,
  [in] UINT32 OperationSet
);

Paramètres

[in] Flags

Indicateurs qui contrôlent la façon dont la voix est arrêtée. Peut être égal à 0 ou à ce qui suit :

Valeur	Description
XAUDIO2_PLAY_TAILS	Continuez à émettre une sortie d’effet après l’arrêt de la voix.

[in] OperationSet

Identifie cet appel dans le cadre d’un lot différé. Pour plus d’informations, consultez vue d’ensemble des ensembles d’opérations XAudio2 .

Valeur retournée

Retourne S_OK en cas de réussite, un code d’erreur dans le cas contraire. Consultez Codes d’erreur XAudio2 pour obtenir des descriptions des codes d’erreur spécifiques à XAudio2.

Remarques

Toutes les mémoires tampons sources qui sont mises en file d’attente sur la voix et la position actuelle du curseur sont conservées. Cela permet à la voix de continuer à partir de là où elle s’est éteinte, lorsqu’elle est redémarrée. La méthode IXAudio2SourceVoice::FlushSourceBuffers peut être utilisée pour vider les mémoires tampons sources en file d’attente.

Par défaut, toute sortie en attente des effets vocaux (par exemple, les queues de réverbération) n’est pas lue. Au lieu de cela, la voix est immédiatement rendue silencieuse. L’indicateur XAUDIO2_PLAY_TAILS peut être utilisé pour continuer à émettre une sortie d’effet après l’arrêt de l’exécution de la voix.

Une voix arrêtée avec l’indicateur XAUDIO2_PLAY_TAILS arrête de consommer des mémoires tampons sources, mais continue de traiter ses effets et d’envoyer de l’audio à ses voix de destination. Une voix dans cet état peut ensuite être arrêtée complètement en appelant à nouveau Stop avec l’argument Flags défini sur 0. Cela permet d’arrêter une voix avec XAUDIO2_PLAY_TAILS, d’attendre suffisamment de temps pour que le son produit par ses effets se termine, puis d’arrêter complètement la voix en appelant à nouveau Stop sans XAUDIO2_PLAY_TAILS. Cette technique permet d’arrêter correctement les voix avec des effets tout en veillant à ce que les voix inactives ne continuent pas à être traitées une fois qu’elles ont fini de produire de l’audio.

Stop est toujours asynchrone, même s’il est appelé dans un rappel.

Note XAudio2 n’appelle jamais de rappel vocal pour une voix si la voix est arrêtée (même si elle a été arrêtée avec XAUDIO2_PLAY_TAILS).

Configuration requise pour la plateforme

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8) ; Kit de développement logiciel (SDK) DirectX (XAudio 2.7)

Spécifications


Plateforme cible	Windows
En-tête	xaudio2.h

Voir aussi

IXAudio2SourceVoice

Vue d’ensemble de XAPO

Partager via