C Specification

The xrCreateSpatialAudioRendererBD function is defined as:

// Provided by XR_BD_spatial_audio_rendering
XrResult xrCreateSpatialAudioRendererBD(
    XrSession                                   session,
    const XrSpatialAudioRendererCreateInfoBD*   createInfo,
    XrSpatialAudioRendererBD*                   renderer);

Parameters

Parameter Descriptions

Description

To create an XrSpatialAudioRendererBD, applications call xrCreateSpatialAudioRendererBD.

Runtimes must allow at most one XrSpatialAudioRendererBD to exist within a session, and must return XR_ERROR_LIMIT_REACHED if an application calls xrCreateSpatialAudioRendererBD to create another XrSpatialAudioRendererBD while another one already exists in the same session.

An application may create a new XrSpatialAudioRendererBD after the previous one has been destroyed by calling xrDestroySpatialAudioRendererBD.

Valid Usage (Implicit)
Return Codes
On success, this command returns

  • XR_SUCCESS

  • XR_SESSION_LOSS_PENDING

On failure, this command returns

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_LIMIT_REACHED

  • XR_ERROR_OUT_OF_MEMORY

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_VALIDATION_FAILURE

See Also

XR_BD_spatial_audio_rendering, XrSession, XrSpatialAudioRendererBD, XrSpatialAudioRendererCreateInfoBD

Document Notes

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.

Copyright

Copyright 2014-2026 The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.