Set up the Development Environment

Download Android Studio

Start by downloading and installing the latest version of Android Studio on your host machine.

The instructions for this learning path were tested on a host machine running macOS, but you can use any of the supported hardware systems listed on the Install Android Studio webpage on the Android Developer website.

After installation, open Android Studio and do the following:

• Accept license agreements.
• Download all the required assets.
• Select the default or recommended settings.

Create a new Android project

1. Navigate to File > New > New Project.

2. Select Empty Views Activity in the Phone and Tablet gallery as Figure 1 shows, then select Next. Figure 1: Select Empty Views Activity.

3. Choose a project name, and select the default configurations as Figure 2 shows.

   Make sure that the Language field is set to Kotlin, and the Build configuration language field is set to Kotlin DSL. Figure 2: Project Configuration.

Add CameraX dependencies

CameraX is a Jetpack library, built to help make camera app development easier. It provides a consistent, easy-to-use API that works across the vast majority of Android devices with great backward-compatibility.

1. Wait for Android Studio to sync project with Gradle files. This might take several minutes.

2. Once the project is synced, navigate to libs.versions.toml in your project’s root directory. See Figure 3. This file serves as the version catalog for all dependencies that the project uses.

Figure 3: Version Catalog.

3. Append the following line to the end of [versions] section. This defines the version of CameraX libraries that you will be using.

    

        
        
            camerax = "1.4.0"
        
    

4. Append the following lines to the end of [libraries] section. This declares the group, name and version of CameraX dependencies.

    

        
        
            camera-core = { group = "androidx.camera", name = "camera-core", version.ref = "camerax" }
camera-camera2 = { group = "androidx.camera", name = "camera-camera2", version.ref = "camerax" }
camera-lifecycle = { group = "androidx.camera", name = "camera-lifecycle", version.ref = "camerax" }
camera-view = { group = "androidx.camera", name = "camera-view", version.ref = "camerax" }
        
    

5. Navigate to build.gradle.kts in your project’s app directory, then insert the following lines into dependencies block. This introduces the dependencies listed above into the app subproject:

    

        
        
                implementation(libs.camera.core)
    implementation(libs.camera.camera2)
    implementation(libs.camera.lifecycle)
    implementation(libs.camera.view)
        
    

Enable view binding

1. Within the above build.gradle.kts file, append the following lines to the end of android block to enable the view binding feature:

    

        
        
                buildFeatures {
        viewBinding = true
    }
        
    

2. You should see that a notification appears. See Figure 4. Click Sync Now to sync your project.

Figure 4: Gradle Sync.

3. Navigate to the MainActivity.kt source file and make the changes that Figure 5 shows in the View Binding screenshot.

   This inflates the layout file into a view binding object, and stores it in a member variable within the view controller for easier access later.

Figure 5: View Binding.

Configure CameraX preview

1. Within the layout file activity_main.xml, replace the placeholder “Hello World!” in TextView with a camera preview view:

    

        
        
                <androidx.camera.view.PreviewView
        android:id="@+id/view_finder"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:scaleType="fillStart" />
        
    

2. Add the following member variables to MainActivity.kt to store camera-related objects:

    

        
        
                // Camera
    private var camera: Camera? = null
    private var cameraProvider: ProcessCameraProvider? = null
    private var preview: Preview? = null
        
    

3. Add two new private methods named setupCamera() and bindCameraUseCases() within MainActivity.kt:

    

        
        
                private fun setupCamera() {
        viewBinding.viewFinder.post {
            cameraProvider?.unbindAll()

            ProcessCameraProvider.getInstance(baseContext).let {
                it.addListener(
                    {
                        cameraProvider = it.get()

                        bindCameraUseCases()
                    },
                    Dispatchers.Main.asExecutor()
                )
            }
        }
    }

    private fun bindCameraUseCases() {
        // TODO: TO BE IMPLEMENTED
    }
        
    

4. Implement the bindCameraUseCases() method:

    

        
        
            private fun bindCameraUseCases() {
        val cameraProvider = cameraProvider
            ?: throw IllegalStateException("Camera initialization failed.")

        val cameraSelector =
            CameraSelector.Builder().requireLensFacing(CameraSelector.LENS_FACING_FRONT).build()

        // Only using the 4:3 ratio because this is the closest to MediaPipe models
        val resolutionSelector =
            ResolutionSelector.Builder()
                .setAspectRatioStrategy(AspectRatioStrategy.RATIO_4_3_FALLBACK_AUTO_STRATEGY)
                .build()
        val targetRotation = viewBinding.viewFinder.display.rotation

        // Preview usecase.
        preview = Preview.Builder()
            .setResolutionSelector(resolutionSelector)
            .setTargetRotation(targetRotation)
            .build()

        // Must unbind the use-cases before rebinding them
        cameraProvider.unbindAll()

        try {
            // A variable number of use-cases can be passed here -
            // camera provides access to CameraControl & CameraInfo
            camera = cameraProvider.bindToLifecycle(
                this, cameraSelector, preview,
            )

            // Attach the viewfinder's surface provider to preview use case
            preview?.surfaceProvider = viewBinding.viewFinder.surfaceProvider
        } catch (exc: Exception) {
            Log.e(TAG, "Use case binding failed", exc)
        }
    }
        
    

5. Add a companion object to MainActivity.kt, and declare a TAG constant value for Log calls to work correctly. This companion object is useful in enabling you to define all the constants and shared values accessible across the entire class.

    

        
        
                companion object {
        private const val TAG = "MainActivity"
    }
        
    

In the next section, you will build and run the app to ensure that the camera works as expected.