IXAudio2Voice::D isableEffect-Methode (xaudio2.h)
Deaktiviert den Effekt an einer bestimmten Position in der Effektkette der Stimme.
Syntax
\\HRESULT DisableEffect(
[in] UINT32 EffectIndex,
[in] UINT32 OperationSet
);
Parameter
[in] EffectIndex
Nullbasierter Index eines Effekts in der Effektkette der Stimme.
[in] OperationSet
Identifiziert diesen Aufruf als Teil eines verzögerten Batches. Weitere Informationen finden Sie in der Übersicht über XAudio2-Vorgangssätze .
Rückgabewert
Gibt bei erfolgreicher Ausführung S_OK zurück. andernfalls ein Fehlercode. Beschreibungen gültiger Fehlercodes finden Sie unter XAudio2-Fehlercodes .
Hinweise
Die Effekte in der Effektkette einer bestimmten XAudio2-Stimme müssen Audio mit der Verarbeitungs-Abtastrate dieser Stimme nutzen und erzeugen. Der einzige Aspekt des Audioformats, das sie ändern können, ist die Kanalanzahl. Beispielsweise kann ein Halleffekt Monodaten in 5.1 konvertieren. Der Client kann das OutputChannels-Feld der XAUDIO2_EFFECT_DESCRIPTOR-Struktur verwenden, um die Anzahl der Kanäle anzugeben, die von den einzelnen Effekten erzeugt werden sollen. Jeder Effekt in einer Effektkette muss eine Reihe von Kanälen erzeugen, die der nächste Effekt nutzen kann. Alle Aufrufe von IXAudio2Voice::EnableEffect oder IXAudio2Voice::D isableEffect , die dazu führen würden, dass die Effektkette diese Anforderungen nicht mehr erfüllt, schlagen fehl.
Wenn Sie einen Effekt deaktivieren, wird er sofort aus dem Verarbeitungsdiagramm entfernt. Alle ausstehenden Audiodaten im Effekt, z. B. ein Hallende, werden nicht wiedergegeben. Achten Sie darauf, einen Effekt zu deaktivieren, während die Stimme, die ihn hostet, ausgeführt wird. Dies kann zu einem hörbaren Artefakt führen, wenn der Effekt die Tonhöhe oder Lautstärke des Audios erheblich ändert.
DisableEffect wird sofort wirksam, wenn von einem XAudio2-Rückruf mit einem OperationSetvon XAUDIO2_COMMIT_NOW aufgerufen wird.
Plattformanforderungen
Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)Anforderungen
| Anforderung | Wert |
|---|---|
| Zielplattform | Windows |
| Kopfzeile | xaudio2.h |