C Specification

The xrQueryFramesPerBufferRangeBD function is defined as:

// Provided by XR_BD_spatial_audio_rendering
XrResult xrQueryFramesPerBufferRangeBD(
    XrSession                                   session,
    XrAudioSampleRateBD                         sampleRate,
    uint32_t*                                   min,
    uint32_t*                                   max);

Parameters

Parameter Descriptions

  • session is the XrSession to query supported frames per buffer range.

  • sampleRate is the sample rate for which the supported frames per buffer range is queried.

  • min is a pointer to an uint32_t that receives the minimum supported frames per buffer.

  • max is a pointer to an uint32_t that receives the maximum supported frames per buffer.

Description

Before creating the XrSpatialAudioRendererBD, applications should call xrQueryFramesPerBufferRangeBD to query supported frames per buffer range. Applications must set XrSpatialAudioRendererCreateInfoBD::framesPerBuffer to a value within the supported range, otherwise the runtime must return XR_ERROR_VALIDATION_FAILURE from xrCreateSpatialAudioRendererBD.

The values enumerated by this function must not change during the lifetime of an XrInstance.

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_RUNTIME_FAILURE

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_VALIDATION_FAILURE

See Also

XR_BD_spatial_audio_rendering, XrAudioSampleRateBD, XrSession

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.