C Specification

The xrCreateSoundFieldBD function is defined as:

// Provided by XR_BD_spatial_audio_rendering
XrResult xrCreateSoundFieldBD(
    XrSpatialAudioRendererBD                    renderer,
    const XrSoundFieldConfigBD*                 config,
    XrSoundFieldBD*                             soundField);

Parameters

Parameter Descriptions

Description

When creating a sound field in the sound scene rendered by the spatial audio renderer, applications must chain a structure that indicates the channel definition of the sound field to XrSoundFieldConfigBD::next.

Channel definitions specified by this extension are:

If the application does not chain any structure specifying the sound format to XrSoundFieldConfigBD::next, the runtime must return XR_ERROR_VALIDATION_FAILURE.

If multiple sound field config structures are chained, the runtime ignores all but one of those structs. To avoid unexpected results, applications should only chain one sound field definition structure to indicate the channel definition of the sound field.

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_POSE_INVALID

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_VALIDATION_FAILURE

See Also

XR_BD_spatial_audio_rendering, XrSoundFieldBD, XrSoundFieldConfigBD, XrSpatialAudioRendererBD

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.