ArHostCloudAnchorFuture

An asynchronous operation for hosting a Cloud Anchor launched by ArSession_hostCloudAnchorAsync.

See the Cloud Anchors developer guide for more information.

Summary

Typedefs

ArHostCloudAnchorCallback)(void *context, char *cloud_anchor_id, ArCloudAnchorState cloud_anchor_state) typedef
void(*
Callback definition for ArSession_hostCloudAnchorAsync.
ArHostCloudAnchorFuture typedef
struct ArHostCloudAnchorFuture_
Handle to an asynchronous operation launched by ArSession_hostCloudAnchorAsync.

Functions

ArHostCloudAnchorFuture_acquireResultCloudAnchorId(const ArSession *session, const ArHostCloudAnchorFuture *future, char **out_cloud_anchor_id)
void
Gets the Cloud Anchor ID of the hosted anchor.
ArHostCloudAnchorFuture_getResultCloudAnchorState(const ArSession *session, const ArHostCloudAnchorFuture *future, ArCloudAnchorState *out_cloud_anchor_state)
void
Gets the result status of the hosting operation, if the operation is done.

Typedefs

ArHostCloudAnchorCallback

void(* ArHostCloudAnchorCallback)(void *context, char *cloud_anchor_id, ArCloudAnchorState cloud_anchor_state)

Callback definition for ArSession_hostCloudAnchorAsync.

The context argument will be the same as that passed to ArSession_hostCloudAnchorAsync. The cloud_anchor_id argument will contain the same value as that returned by ArHostCloudAnchorFuture_acquireResultCloudAnchorId and must be released using ArString_release. The cloud_anchor_state argument will be the same as that returned by ArHostCloudAnchorFuture_getResultCloudAnchorState.

It is a best practice to free context memory provided to ArSession_hostCloudAnchorAsync at the end of the callback implementation.

ArHostCloudAnchorFuture

struct ArHostCloudAnchorFuture_ ArHostCloudAnchorFuture

Handle to an asynchronous operation launched by ArSession_hostCloudAnchorAsync.

See the Cloud Anchors developer guide for more information.

Release with ArFuture_release. (reference type, long-lived).

Functions

ArHostCloudAnchorFuture_acquireResultCloudAnchorId

void ArHostCloudAnchorFuture_acquireResultCloudAnchorId(
  const ArSession *session,
  const ArHostCloudAnchorFuture *future,
  char **out_cloud_anchor_id
)

Gets the Cloud Anchor ID of the hosted anchor.

If the operation isn't done yet or the operation failed, this will be NULL. The caller must release the string using ArString_release.

Details
Parameters
session
The ARCore session.
future
The handle for the asynchronous operation.
out_cloud_anchor_id
The Cloud Anchor ID.

ArHostCloudAnchorFuture_getResultCloudAnchorState

void ArHostCloudAnchorFuture_getResultCloudAnchorState(
  const ArSession *session,
  const ArHostCloudAnchorFuture *future,
  ArCloudAnchorState *out_cloud_anchor_state
)

Gets the result status of the hosting operation, if the operation is done.

Details
Parameters
session
The ARCore session.
future
The handle for the asynchronous operation.
out_cloud_anchor_state
The result status.