mediapipe/docs/getting_started/android_solutions.md
MediaPipe Team 33d683c671 Project import generated by Copybara.
GitOrigin-RevId: 373e3ac1e5839befd95bf7d73ceff3c5f1171969
2021-10-06 14:27:49 -07:00

3.0 KiB

layout title parent grand_parent nav_order
default Android Solutions MediaPipe on Android Getting Started 2

Android Solution APIs

{: .no_toc }

  1. TOC {:toc}

Please follow instructions below to use the MediaPipe Solution APIs in Android Studio projects and build the Android example apps in the supported MediaPipe solutions.

Integrate MediaPipe Android Solutions in Android Studio

MediaPipe Android Solution APIs (currently in alpha) are now available in Google's Maven Repository. To incorporate MediaPipe Android Solutions into an Android Studio project, add the following into the project's Gradle dependencies:

dependencies {
    // MediaPipe solution-core is the foundation of any MediaPipe Solutions.
    implementation 'com.google.mediapipe:solution-core:latest.release'
    // Optional: MediaPipe Face Detection Solution.
    implementation 'com.google.mediapipe:facedetection:latest.release'
    // Optional: MediaPipe Face Mesh Solution.
    implementation 'com.google.mediapipe:facemesh:latest.release'
    // Optional: MediaPipe Hands Solution.
    implementation 'com.google.mediapipe:hands:latest.release'
    // MediaPipe deps
    implementation 'com.google.flogger:flogger:0.6'
    implementation 'com.google.flogger:flogger-system-backend:0.6'
    implementation 'com.google.guava:guava:27.0.1-android'
    implementation 'com.google.protobuf:protobuf-java:3.11.4'
    // CameraX core library
    def camerax_version = "1.0.0-beta10"
    implementation "androidx.camera:camera-core:$camerax_version"
    implementation "androidx.camera:camera-camera2:$camerax_version"
    implementation "androidx.camera:camera-lifecycle:$camerax_version"
}

See the detailed solution APIs usage examples for different use cases in the solution example apps' source code. If the prebuilt maven packages are not sufficient, building the MediaPipe Android archive library locally by following these instructions.

Build solution example apps in Android Studio

  1. Open Android Studio Arctic Fox on Linux, macOS, or Windows.

  2. Import mediapipe/examples/android/solutions directory into Android Studio.

    Screenshot

  3. For Windows users, run create_win_symlinks.bat as administrator to create res directory symlinks.

    Screenshot

  4. Select "File" -> "Sync Project with Gradle Files" to sync project.

  5. Run solution example app in Android Studio.

    Screenshot

  6. (Optional) Run solutions on CPU.

    MediaPipe solution example apps run the pipeline and the model inference on GPU by default. If needed, for example to run the apps on Android Emulator, set the RUN_ON_GPU boolean variable to false in the app's MainActivity.java to run the pipeline and the model inference on CPU.