xrDestroySoundObjectBD(3)

C Specification

The xrDestroySoundObjectBD function is defined as:

// Provided by XR_BD_spatial_audio_rendering
XrResult xrDestroySoundObjectBD(
    XrSoundObjectBD                             soundObject);

Parameter Descriptions

When an application removes a sound object with xrDestroySoundObjectBD, its corresponding sound is not rendered anymore.

Valid Usage (Implicit)

The XR_BD_spatial_audio_rendering extension must be enabled prior to calling xrDestroySoundObjectBD
soundObject must be a valid XrSoundObjectBD handle

Thread Safety

Access to soundObject, and any child handles, must be externally synchronized

Return Codes

On success, this command returns

On failure, this command returns

For more information, see the OpenXR Specification

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.