C Specification

The xrStartSenseDataProviderAsyncBD function is defined as:

// Provided by XR_BD_spatial_sensing
XrResult xrStartSenseDataProviderAsyncBD(
    XrSenseDataProviderBD                       provider,
    const XrSenseDataProviderStartInfoBD*       startInfo,
    XrFutureEXT*                                future);

Parameters

Parameter Descriptions

Description

The application can start a previously created sense data provider using xrStartSenseDataProviderAsyncBD when it is in either the XR_SENSE_DATA_PROVIDER_STATE_INITIALIZED_BD or the XR_SENSE_DATA_PROVIDER_STATE_STOPPED_BD state.

This function starts an asynchronous operation and creates a corresponding XrFutureEXT, usable with xrPollFutureEXT and related functions. The return value of this function only indicates whether the parameters were acceptable to schedule the asynchronous operation. The corresponding completion function is xrStartSenseDataProviderCompleteBD, usable when a future from this function is in the READY state, with outputs populated by that function in the completion structure XrFutureCompletionEXT.

If the sense data provider is already in the XR_SENSE_DATA_PROVIDER_STATE_RUNNING_BD state, calling this function does not change the provider state. In this case, the runtime must still set the return value of xrStartSenseDataProviderAsyncBD to XR_SUCCESS, and the future state will be XR_FUTURE_STATE_READY_EXT immediately. The runtime must set the corresponding future result returned by xrStartSenseDataProviderCompleteBD to XR_SUCCESS.

Individual sense data provider types may specify required a permission or permissions to use their capabilities on Android-based platforms. If the specified provider type requires a permission and that permission is not listed in the application’s manifest, or the permission is listed but denied, the future state will be XR_FUTURE_STATE_READY_EXT immediately and the runtime must set the corresponding future result returned by xrStartSenseDataProviderCompleteBD to XR_ERROR_PERMISSION_INSUFFICIENT.

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_VALIDATION_FAILURE

  • XR_ERROR_RUNTIME_FAILURE

  • XR_ERROR_HANDLE_INVALID

  • XR_ERROR_INSTANCE_LOST

  • XR_ERROR_SESSION_LOST

  • XR_ERROR_SPATIAL_SENSING_SERVICE_UNAVAILABLE_BD

  • XR_ERROR_FEATURE_UNSUPPORTED

See Also

XR_BD_spatial_sensing, XrFutureEXT, XrSenseDataProviderBD, XrSenseDataProviderStartInfoBD

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-2025 The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.