C Specification

The xrSubmitSoundFieldBufferBD function is defined as:

// Provided by XR_BD_spatial_audio_rendering
XrResult xrSubmitSoundFieldBufferBD(
    XrSoundFieldBD                              soundField,
    const XrAudioBufferBD*                      buffer);

Parameters

Parameter Descriptions

  • soundField is the XrSoundFieldBD to input audio signal.

  • buffer is a pointer to an XrAudioBufferBD structure that contains the input audio signal.

Description

This function submits an audio buffer to a sound field XrSoundFieldBD. The corresponding function for a sound object XrSoundObjectBD is xrSubmitSoundObjectBufferBD.

This function must only be called during an audio period, which is the time period after a successful and not timed out call to xrWaitAudioPeriodBD and before a successful call to xrEndAudioPeriodBD, otherwise the runtime must return XR_ERROR_CALL_ORDER_INVALID.

For each sound field, this function must not be called more than once per audio period, otherwise the runtime must return XR_ERROR_CALL_ORDER_INVALID.

The buffer must

If any of the above conditions are not met, the runtime must return XR_ERROR_VALIDATION_FAILURE.

When valid audio is submitted, the runtime must correctly process and render the spatial audio.

Applications must not call this function concurrently with xrWaitAudioPeriodBD or xrEndAudioPeriodBD. Doing so may result in undefined behavior.

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

  • XR_SUCCESS

  • XR_SESSION_LOSS_PENDING

On failure, this command returns

  • XR_ERROR_CALL_ORDER_INVALID

  • XR_ERROR_FUNCTION_UNSUPPORTED

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_VALIDATION_FAILURE

See Also

XR_BD_spatial_audio_rendering, XrAudioBufferBD, XrSoundFieldBD

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.