stevenfour/OculusSdk · Datasets at Hugging Face

text stringlengths 0 1.11k
Resolution

If the Spatial Anchor is not uploaded, first invoke the save operation to cloud, and then share the anchor again.
If a Spatial Anchor is already uploaded, you do not have to re-upload the anchor to share it again. In this case, invoke the share operation without invoking the save operation.
Anchor Location is Incorrect

The Shared Anchor is not in the same place on the sender and recipient’s devices.

During testing, you may find that the Spatial Anchor that was shared is not in the expected position on the recipient’s device. This can happen if the system does not correctly localize the Shared Anchor.

Resolution

For the best experience, we recommend that users enter Passthrough and walk around in a large circle (while communicating with and staying mindful of the location of others) around the center of their playspace before using experiences that use Shared Spatial Anchors. Optionally, you may communicate to the user to walk and look around the playspace. If the anchor’s pose does not automatically correct, you can destroy the anchor and download it again.

Handling SSA Error Codes

XR_ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB
You encounter

OVRSpatialAnchor.OperationResult.Failure_SpaceCloudStorageDisabled

when attempting to save, load, or share Spatial Anchors

When attempting to upload, download, or share Spatial Anchors, you may receive error “cloud sotrage disabled”. Additionally, the logs will contain one or more of the following:

Request denied based on storage location for package {}, sessionUuid:{}.
getCloudPermissionEnabled: oculus_spatial_anchor_cloud=false
Some known causes are:

The user has disabled “Share point cloud data” in Settings > Privacy, or has selected “Not now” in the dialog presented the first time they launch an experience that supports point cloud data sharing. In this case, the logs should contain any of:
PreferencesManager: anchor_persistence_cloud_anchor_service_enabled: false
userPreference(anchor_persistence_cloud_anchor_service_enabled)=false
The headset and/or OS version does not support Shared Spatial Anchors. In this case, the logs should contain any of:
checkGatekeeper gatekeeperName: oculus_spatial_anchor_cloud, value: false
GK(oculus_spatial_anchor_cloud)=false
Resolution

The user must take action to grant permissions to share point cloud data for this feature to work. You can surface a prompt to indicate to the user to enable sharing point cloud data from Settings > Privacy.

XR_ERROR_SPACE_COMPONENT_NOT_ENABLED_FB
You encounter XR_ERROR_SPACE_COMPONENT_NOT_ENABLED_FB when attempting to save, upload, or share an anchor.

You are attempting the operation for an anchor that does not have the required components enabled. This could be because you are attempting to save, upload, or share a Scene Anchor, which is managed by the Meta Quest operating system.

Resolution

Make sure every anchor you are attempting to save or share is a Spatial Anchor (not a Scene Anchor). In Unity and Unreal, the class of the object you are using will indicate whether it is a Spatial Anchor.

If you are using the OpenXR API, use the following code to check for component status before saving or uploading an anchor, given an XrSpace:

XrSpaceComponentStatusFB storableStatus;
xrGetSpaceComponentStatusFB(
space, XR_SPACE_COMPONENT_TYPE_STORABLE_FB, &storableStatus));
if (storableStatus.enabled) {
// Save or upload the anchor.
}
Use the following code to check for component status before sharing an anchor, given an XrSpace:

XrSpaceComponentStatusFB sharableStatus;
xrGetSpaceComponentStatusFB(
space, XR_SPACE_COMPONENT_TYPE_SHARABLE_FB, &sharableStatus));
if (sharableStatus.enabled) {
// Share the anchor.
}
XR_ERROR_SPACE_MAPPING_INSUFFICIENT_FB
You encounter

OVRSpatialAnchor.OperationResult.Failure_SpaceMappingInsufficient

when attempting to save, load, or share an anchor.

This error occurs when the device’s maping of the current physical surroundings is not complete enough to reliably save or load a SSA.

Resolution

Prompting users to look around the room to ensure the device has fully mapped the space and then retrying the operation that led to this failure.

XR_ERROR_SPACE_LOCALIZATION_FAILED_FB
You encounter

OVRSpatialAnchor.OperationResult.Failure_SpaceLocalizationFailed

when attempting to save, load, or share an anchor.

This error occurs when anchors are successfully loaded from the cloud, but cannot be aligned with the device’s map of its physical surroundings.

Resolution

This error typically occurs when there is poor coordination between the user that has saved and shared the SSA and the user attempting to load the SSA. (i.e. the host user asks a guest user to load an anchor that is not located in their current space)

A possible mitigation is to prompt users to look around the room to ensure the device has fully mapped the space and then retrying the operation that led to this failure.

XR_ERROR_SPACE_NETWORK_TIMEOUT_FB
You encounter

OVRSpatialAnchor.OperationResult.Failure_SpaceNetworkTimeout

when attempting to save, load, or share an anchor.

This error occurs when there is failure to complete cloud-based saves and loads due to a network timeout.

Resolution

If the Spatial Anchor is not uploaded, first invoke the save operation to cloud, and then share the anchor again.

If a Spatial Anchor is already uploaded, you do not have to re-upload the anchor to share it again. In this case, invoke the share operation without invoking the save operation.

Anchor Location is Incorrect

The Shared Anchor is not in the same place on the sender and recipient’s devices.

During testing, you may find that the Spatial Anchor that was shared is not in the expected position on the recipient’s device. This can happen if the system does not correctly localize the Shared Anchor.

Resolution

For the best experience, we recommend that users enter Passthrough and walk around in a large circle (while communicating with and staying mindful of the location of others) around the center of their playspace before using experiences that use Shared Spatial Anchors. Optionally, you may communicate to the user to walk and look around the playspace. If the anchor’s pose does not automatically correct, you can destroy the anchor and download it again.

Handling SSA Error Codes

XR_ERROR_SPACE_CLOUD_STORAGE_DISABLED_FB

You encounter

OVRSpatialAnchor.OperationResult.Failure_SpaceCloudStorageDisabled

when attempting to save, load, or share Spatial Anchors

When attempting to upload, download, or share Spatial Anchors, you may receive error “cloud sotrage disabled”. Additionally, the logs will contain one or more of the following:

Request denied based on storage location for package {}, sessionUuid:{}.

getCloudPermissionEnabled: oculus_spatial_anchor_cloud=false

Some known causes are:

The user has disabled “Share point cloud data” in Settings > Privacy, or has selected “Not now” in the dialog presented the first time they launch an experience that supports point cloud data sharing. In this case, the logs should contain any of:

PreferencesManager: anchor_persistence_cloud_anchor_service_enabled: false

userPreference(anchor_persistence_cloud_anchor_service_enabled)=false

The headset and/or OS version does not support Shared Spatial Anchors. In this case, the logs should contain any of:

checkGatekeeper gatekeeperName: oculus_spatial_anchor_cloud, value: false

GK(oculus_spatial_anchor_cloud)=false

Resolution

The user must take action to grant permissions to share point cloud data for this feature to work. You can surface a prompt to indicate to the user to enable sharing point cloud data from Settings > Privacy.

XR_ERROR_SPACE_COMPONENT_NOT_ENABLED_FB

You encounter XR_ERROR_SPACE_COMPONENT_NOT_ENABLED_FB when attempting to save, upload, or share an anchor.

You are attempting the operation for an anchor that does not have the required components enabled. This could be because you are attempting to save, upload, or share a Scene Anchor, which is managed by the Meta Quest operating system.

Resolution

Make sure every anchor you are attempting to save or share is a Spatial Anchor (not a Scene Anchor). In Unity and Unreal, the class of the object you are using will indicate whether it is a Spatial Anchor.

If you are using the OpenXR API, use the following code to check for component status before saving or uploading an anchor, given an XrSpace:

XrSpaceComponentStatusFB storableStatus;

xrGetSpaceComponentStatusFB(

space, XR_SPACE_COMPONENT_TYPE_STORABLE_FB, &storableStatus));

if (storableStatus.enabled) {

// Save or upload the anchor.

}

Use the following code to check for component status before sharing an anchor, given an XrSpace:

XrSpaceComponentStatusFB sharableStatus;

xrGetSpaceComponentStatusFB(

space, XR_SPACE_COMPONENT_TYPE_SHARABLE_FB, &sharableStatus));

if (sharableStatus.enabled) {

// Share the anchor.

}

XR_ERROR_SPACE_MAPPING_INSUFFICIENT_FB

You encounter

OVRSpatialAnchor.OperationResult.Failure_SpaceMappingInsufficient

when attempting to save, load, or share an anchor.

This error occurs when the device’s maping of the current physical surroundings is not complete enough to reliably save or load a SSA.

Resolution

Prompting users to look around the room to ensure the device has fully mapped the space and then retrying the operation that led to this failure.

XR_ERROR_SPACE_LOCALIZATION_FAILED_FB

You encounter

OVRSpatialAnchor.OperationResult.Failure_SpaceLocalizationFailed

when attempting to save, load, or share an anchor.

This error occurs when anchors are successfully loaded from the cloud, but cannot be aligned with the device’s map of its physical surroundings.

Resolution

This error typically occurs when there is poor coordination between the user that has saved and shared the SSA and the user attempting to load the SSA. (i.e. the host user asks a guest user to load an anchor that is not located in their current space)

A possible mitigation is to prompt users to look around the room to ensure the device has fully mapped the space and then retrying the operation that led to this failure.

XR_ERROR_SPACE_NETWORK_TIMEOUT_FB

You encounter

OVRSpatialAnchor.OperationResult.Failure_SpaceNetworkTimeout

when attempting to save, load, or share an anchor.

This error occurs when there is failure to complete cloud-based saves and loads due to a network timeout.