C Specification

The XrSpatialAudioRendererCreateInfoBD structure is defined as:

// Provided by XR_BD_spatial_audio_rendering
typedef struct XrSpatialAudioRendererCreateInfoBD {
    XrStructureType        type;
    const void*            next;
    uint32_t               framesPerBuffer;
    XrAudioSampleRateBD    sampleRate;
} XrSpatialAudioRendererCreateInfoBD;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

  • next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

  • framesPerBuffer is the number of frames contained in each audio data buffer submitted by the application. Each frame consists of one sample for each channel. Applications should call xrQueryFramesPerBufferRangeBD to get the supported range of framesPerBuffer, and must set the framesPerBuffer to a value within the supported range.

  • sampleRate is the number of audio frames per second of the audio data submitted by the application. Applications should call xrEnumerateSupportedAudioSampleRateBD to get the supported sample rates, and must set the sampleRate as one of the supported sample rates.

Description

The XrSpatialAudioRendererCreateInfoBD structure describes the audio configuration the application will use for the submitted audio data. The values of framesPerBuffer and sampleRate must be a supported value according to their respective functions xrEnumerateSupportedAudioSampleRateBD and xrQueryFramesPerBufferRangeBD. If the specified values are not supported by the runtime, xrCreateSpatialAudioRendererBD must return XR_ERROR_VALIDATION_FAILURE.

Valid Usage (Implicit)

See Also

XR_BD_spatial_audio_rendering, XrAudioSampleRateBD, XrStructureType, xrCreateSpatialAudioRendererBD

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.