C Specification

The xrEndAudioPeriodBD function is defined as:

// Provided by XR_BD_spatial_audio_rendering
XrResult xrEndAudioPeriodBD(
    XrSpatialAudioRendererBD                    renderer);

Parameters

Parameter Descriptions

Description

This function notifies the runtime of the end of the current audio period, which means that the application finished submitting all audio buffers for the current audio period and the runtime must start further processing them for spatial rendering.

This function must only be called after a successful and not timed out call to xrWaitAudioPeriodBD, otherwise the runtime must return XR_ERROR_CALL_ORDER_INVALID.

Calling this function must be externally synchronized by the application, concurrent calls 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

See Also

XR_BD_spatial_audio_rendering, 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.