Google is committed to advancing racial equity for Black communities. See how.

ArImageMetadata

Provides access to CPU image camera metadata.

Summary

Typedefs

ACameraMetadata typedef
Forward declaring the ACameraMetadata struct from Android NDK, which is used in ArImageMetadata_getNdkCameraMetadata.
ArImageMetadata typedef
struct ArImageMetadata_
Camera capture metadata (reference type, large data).
ArImageMetadata_const_entry typedef
Defines a single read-only image metadata entry.
ArImageMetadata_rational typedef
Defines a rational data type in ArImageMetadata_const_entry.

Functions

ArImageMetadata_getAllKeys(const ArSession *session, const ArImageMetadata *image_metadata, int32_t *out_number_of_tags, const uint32_t **out_tags)
void
Retrieves the list of the supported image metadata tags that can be queried for their value.
ArImageMetadata_getConstEntry(const ArSession *session, const ArImageMetadata *image_metadata, uint32_t tag, ArImageMetadata_const_entry *out_metadata_entry)
Get a metadata entry for the provided ArImageMetadata and tag.
ArImageMetadata_getNdkCameraMetadata(const ArSession *session, const ArImageMetadata *image_metadata, const ACameraMetadata **out_ndk_metadata)
void
Deprecated. Deprecated in release 1.20.0. Use ArImageMetadata_getConstEntry instead of ACameraMetadata_getConstEntry.
Retrieves the capture metadata for the current camera image.
ArImageMetadata_release(ArImageMetadata *metadata)
void
Releases a reference to the metadata.

Structs

ArImageMetadata_const_entry

Defines a single read-only image metadata entry.

ArImageMetadata_rational

Defines a rational data type in ArImageMetadata_const_entry.

Typedefs

ACameraMetadata

struct ACameraMetadata ACameraMetadata

Forward declaring the ACameraMetadata struct from Android NDK, which is used in ArImageMetadata_getNdkCameraMetadata.

ArImageMetadata

struct ArImageMetadata_ ArImageMetadata

Camera capture metadata (reference type, large data).

ArImageMetadata_const_entry

struct ArImageMetadata_const_entry ArImageMetadata_const_entry

Defines a single read-only image metadata entry.

Struct matches ACameraMetadata_const_entry in Android NDK r21.

ArImageMetadata_rational

struct ArImageMetadata_rational ArImageMetadata_rational

Defines a rational data type in ArImageMetadata_const_entry.

Struct matches ACameraMetadata_rational in Android NDK r21.

Functions

ArImageMetadata_getAllKeys

void ArImageMetadata_getAllKeys(
  const ArSession *session,
  const ArImageMetadata *image_metadata,
  int32_t *out_number_of_tags,
  const uint32_t **out_tags
)

Retrieves the list of the supported image metadata tags that can be queried for their value.

The out_tags list remains valid until image_metadata is released via ArImageMetadata_release.

Details
Parameters
session
The ARCore session.
image_metadata
out_number_of_tags
Number of metadata tags returned in the list.
out_tags
The data pointer to the beginning of the list of uint32_t tags.

ArImageMetadata_getConstEntry

ArStatus ArImageMetadata_getConstEntry(
  const ArSession *session,
  const ArImageMetadata *image_metadata,
  uint32_t tag,
  ArImageMetadata_const_entry *out_metadata_entry
)

Get a metadata entry for the provided ArImageMetadata and tag.

The returned out_metadata_entry remains valid until the provided image_metadata is released via ArFrame_acquireImageMetadata.

Details
Parameters
session
The ARCore session.
image_metadata
tag
The desired uint32_t metadata tag to be retrieved from the provided ArImageMetadata struct.
out_metadata_entry
The ArImageMetadata_const_entry struct to which the metadata tag data should be written to, updated only when function returns AR_SUCCESS.
Returns
AR_SUCCESS or any of:

ArImageMetadata_getNdkCameraMetadata

void ArImageMetadata_getNdkCameraMetadata(
  const ArSession *session,
  const ArImageMetadata *image_metadata,
  const ACameraMetadata **out_ndk_metadata
)

Retrieves the capture metadata for the current camera image.

ACameraMetadata is a struct in Android NDK. Include NdkCameraMetadata.h to use this type.

Note: The ACameraMetadata returned from this function will be invalid after its ArImageMetadata object is released. Deprecated. Deprecated in release 1.20.0. Use ArImageMetadata_getConstEntry instead of ACameraMetadata_getConstEntry.

ArImageMetadata_release

void ArImageMetadata_release(
  ArImageMetadata *metadata
)

Releases a reference to the metadata.

This must match a call to ArFrame_acquireImageMetadata.

This function may safely be called with NULL - it will do nothing.