Stay organized with collections
Save and categorize content based on your preferences.
Configure an ARCore session to build AR experiences for your app.
What is a session?
All AR processes, such as motion tracking,
environmental understanding, and lighting estimation, happen inside an ARCore
session. ArSession is the main entry point to the ARCore
API. It manages the AR system state and handles the session lifecycle, allowing
the app to create, configure, start, or stop a session. Most importantly, it
enables the app to receive frames that allow access to the camera image and
device pose.
The session can be used to configure the following features:
Before creating an ArSession, verify that ARCore is installed and up to date.
If ARCore isn't installed, session creation fails and any subsequent
installation or upgrade of ARCore requires an app restart.
/* * Check if ARCore is currently usable, i.e. whether ARCore is supported and * up to date. */int32_tis_arcore_supported_and_up_to_date(void*env,void*context){ArAvailabilityavailability;ArCoreApk_checkAvailability(env,context,&availability);switch(availability){caseAR_AVAILABILITY_SUPPORTED_INSTALLED:returntrue;caseAR_AVAILABILITY_SUPPORTED_APK_TOO_OLD:caseAR_AVAILABILITY_SUPPORTED_NOT_INSTALLED:{ArInstallStatusinstall_status;// ArCoreApk_requestInstall is processed asynchronously.CHECK(ArCoreApk_requestInstall(env,context,true,&install_status)==AR_SUCCESS);returnfalse;}caseAR_AVAILABILITY_UNSUPPORTED_DEVICE_NOT_CAPABLE:// This device is not supported for AR.returnfalse;caseAR_AVAILABILITY_UNKNOWN_CHECKING:// ARCore is checking the availability with a remote query.// This function should be called again after waiting 200 ms// to determine the query result.handle_check_later();returnfalse;caseAR_AVAILABILITY_UNKNOWN_ERROR:caseAR_AVAILABILITY_UNKNOWN_TIMED_OUT:// There was an error checking for AR availability.// This may be due to the device being offline.// Handle the error appropriately.handle_unknown_error();returnfalse;default:// All enum cases have been handled.returnfalse;}}
Create a session
Create and configure a session in ARCore.
// Create a new ARCore session.ArSession*ar_session=NULL;CHECK(ArSession_create(env,context,&ar_session)==AR_SUCCESS);// Create a session config.ArConfig*ar_config=NULL;ArConfig_create(ar_session,&ar_config);// Do feature-specific operations here, such as enabling depth or turning on// support for Augmented Faces.// Configure the session.CHECK(ArSession_configure(ar_session,ar_config)==AR_SUCCESS);
Close a session
ArSession owns a significant amount of native heap memory. Failure to
explicitly close the session may cause your app to run out of native memory and
crash. When the AR session is no longer needed, call
ArSession_destroy()
to release resources.
// Release memory used by the AR session.ArSession_destroy(session);
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003eARCore sessions manage all AR processes like motion tracking and environmental understanding, and are accessed via the \u003ccode\u003eArSession\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eBefore starting a session, verify ARCore is installed and updated using \u003ccode\u003eArCoreApk_checkAvailability\u003c/code\u003e to ensure smooth functionality.\u003c/p\u003e\n"],["\u003cp\u003eSessions can be configured to enable features like Depth API, Augmented Faces, or Cloud Anchors, providing flexibility for various AR experiences.\u003c/p\u003e\n"],["\u003cp\u003eTo avoid memory leaks and potential crashes, release session resources by calling \u003ccode\u003eArSession_destroy()\u003c/code\u003e when the session is no longer needed.\u003c/p\u003e\n"]]],[],null,["# Configure an ARCore session in Android NDK\n\nConfigure an ARCore session to build AR experiences for your app.\n\nWhat is a session?\n------------------\n\nAll [AR processes](/ar/discover/concepts), such as motion tracking,\nenvironmental understanding, and lighting estimation, happen inside an ARCore\nsession. [`ArSession`](/ar/reference/c/group/ar-session) is the main entry point to the ARCore\nAPI. It manages the AR system state and handles the session lifecycle, allowing\nthe app to create, configure, start, or stop a session. Most importantly, it\nenables the app to receive frames that allow access to the camera image and\ndevice pose.\n\nThe session can be used to configure the following features:\n\n- [Lighting Estimation](/ar/develop/lighting-estimation)\n- [Cloud Anchors](/ar/develop/cloud-anchors)\n- [Augmented Images](/ar/develop/augmented-images)\n- [Augmented Faces](/ar/develop/augmented-faces)\n- [Depth API](/ar/develop/depth)\n- [Instant Placement](/ar/develop/instant-placement)\n- [ARCore Geospatial API](/ar/develop/geospatial)\n\nVerify that ARCore is installed and up to date\n----------------------------------------------\n\nBefore creating an [`ArSession`](/ar/reference/c/group/ar-session), verify that ARCore is installed and up to date.\nIf ARCore isn't installed, session creation fails and any subsequent\ninstallation or upgrade of ARCore requires an app restart.\n\n\u003cbr /\u003e\n\n```c\n/*\n * Check if ARCore is currently usable, i.e. whether ARCore is supported and\n * up to date.\n */\nint32_t is_arcore_supported_and_up_to_date(void* env, void* context) {\n ArAvailability availability;\n ArCoreApk_checkAvailability(env, context, &availability);\n switch (availability) {\n case AR_AVAILABILITY_SUPPORTED_INSTALLED:\n return true;\n case AR_AVAILABILITY_SUPPORTED_APK_TOO_OLD:\n case AR_AVAILABILITY_SUPPORTED_NOT_INSTALLED: {\n ArInstallStatus install_status;\n // ArCoreApk_requestInstall is processed asynchronously.\n CHECK(ArCoreApk_requestInstall(env, context, true, &install_status) ==\n AR_SUCCESS);\n return false;\n }\n case AR_AVAILABILITY_UNSUPPORTED_DEVICE_NOT_CAPABLE:\n // This device is not supported for AR.\n return false;\n case AR_AVAILABILITY_UNKNOWN_CHECKING:\n // ARCore is checking the availability with a remote query.\n // This function should be called again after waiting 200 ms\n // to determine the query result.\n handle_check_later();\n return false;\n case AR_AVAILABILITY_UNKNOWN_ERROR:\n case AR_AVAILABILITY_UNKNOWN_TIMED_OUT:\n // There was an error checking for AR availability.\n // This may be due to the device being offline.\n // Handle the error appropriately.\n handle_unknown_error();\n return false;\n\n default: // All enum cases have been handled.\n return false;\n }\n}\n```\n\nCreate a session\n----------------\n\nCreate and configure a session in ARCore. \n\n```c\n// Create a new ARCore session.\nArSession* ar_session = NULL;\nCHECK(ArSession_create(env, context, &ar_session) == AR_SUCCESS);\n\n// Create a session config.\nArConfig* ar_config = NULL;\nArConfig_create(ar_session, &ar_config);\n\n// Do feature-specific operations here, such as enabling depth or turning on\n// support for Augmented Faces.\n\n// Configure the session.\nCHECK(ArSession_configure(ar_session, ar_config) == AR_SUCCESS);\n```\n\nClose a session\n---------------\n\n`ArSession` owns a significant amount of native heap memory. Failure to\nexplicitly close the session may cause your app to run out of native memory and\ncrash. When the AR session is no longer needed, call\n[`ArSession_destroy()`](/ar/reference/c/group/ar-session#arsession_destroy)\nto release resources. \n\n```c\n// Release memory used by the AR session.\nArSession_destroy(session);\n```\n\nNext steps\n----------\n\n- [ARCore quickstart for Android NDK](/ar/develop/c/quickstart)"]]