Getting Started

Requirements

All VideoKit SDKs work on all Android versions greater than or equal to 21 (Android 5.0). As of April 2023, this means that the SDKs run on 99.3% of active devices. To use the SDKs, depending on your project setup, you might also need to specify the Java version as follows:

// build.gradle / build.gradle.kts
android {
  ...
  compileOptions {
      sourceCompatibility = JavaVersion.VERSION_11
      targetCompatibility = JavaVersion.VERSION_11
  }
  ...
}

Quick Start

All VideoKit SDKs are hosted on a custom maven repository. To integrate them in your library or application, you need to add the repository URL to your Gradle configuration, typically in your root build.gradle or build.gradle.kts file:

repositories {
  maven { url = "https://cdn.video.io/android/maven" }
  maven { url = "https://jitpack.io" } // for videokit-live
  google()
  mavenCentral()
}

After the repository is declared, you can add dependencies to the desired SDK(s). Replace ${version} with the desired VideoKit version. You can find the latest version in the release notes.

implementation("io.video:videokit-core:${version}")

implementation("io.video:videokit-player:${version}")
implementation("io.video:videokit-player-ui:${version}")

implementation("io.video:videokit-recorder:${version}")
implementation("io.video:videokit-recorder-ui:${version}")

// implementation("io.video:videokit-editor:${version}")
// implementation("io.video:videokit-live:${version}")

Note that non-core modules, like videokit-player or videokit-recorder, will automatically add a dependency on videokit-core, so that is not strictly needed.