---
title: "Android Quick Start Guide"
slug: "android-quickstart-guide"
description: "This article serves as a quick start for the android SDK."
updated: 2023-12-21T15:33:28Z
published: 2023-12-21T15:33:28Z
canonical: "docs.screenmeet.com/android-quickstart-guide"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.screenmeet.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Android SDK Quickstart

## Overview

In this guide, you will create a HelloWorld app using Android Studio and integrate the ScreenMeet Mobile SDK. You will be able to being streaming the app to the ScreenMeet session.

## Prerequisites

- Latest version of Android Studio is installed.
- You have a [Mobile API key](https://docs.screenmeet.com/v1/docs/getting-a-mobile-api-key) generated for your organization.
- You have access to create a remote support session for your organization either through Salesforce or the [ScreenMeet Console](https://console.screenmeet.com).

## Step 1 -- Launch Android Studio and create a new "Basic Activity" app. ![](https://cdn.document360.io/9da39725-20e5-434f-83a4-d630456099dc/Images/Documentation/image-1601569904004.png)

## Step 2 -- Fill in the details for the application name and click the "Finish" button. ![](https://cdn.document360.io/9da39725-20e5-434f-83a4-d630456099dc/Images/Documentation/image-1601570023165.png)

## Step 3 -- Find and edit your app/build.gradle file. ![](https://cdn.document360.io/9da39725-20e5-434f-83a4-d630456099dc/Images/Documentation/image-1601570207381.png)

## Step 4 -- Add the compiler compliance declaration

Note

It appears that this is already added in the latest Basic Activity template included with Android Studio. You may skip this step if it's already there.

```groovy
    // NEEDS TO BE SPECIFIED FOR SCREENMEET SDK
    compileOptions {
        targetCompatibility JavaVersion.VERSION_1_8
        sourceCompatibility JavaVersion.VERSION_1_8
    }
```

![](https://cdn.document360.io/9da39725-20e5-434f-83a4-d630456099dc/Images/Documentation/image-1601570615785.png)

## Step 5 -- Add the ScreenMeet maven repository.

```groovy
repositories {
    // NEEDED FOR SCREENMEET SDK
    maven {
        url "https://nexus.screenmeet.com/repository/maven-releases/"
    }
}
```

![](https://cdn.document360.io/9da39725-20e5-434f-83a4-d630456099dc/Images/Documentation/image-1601570698096.png)

## Step 6 -- Add the ScreenMeet SDK dependency

```groovy
    // NEEDED FOR SCREENMEET SDK
    implementation 'com.screenmeet:sdk:3.0.10'
```

![](https://cdn.document360.io/9da39725-20e5-434f-83a4-d630456099dc/Images/Documentation/image-1601570875745.png)

## Step 7 -- Sync the gradle file.

![](https://cdn.document360.io/9da39725-20e5-434f-83a4-d630456099dc/Images/Documentation/image-1601570963973.png)

## Step 8 -- Edit the MainActivity.java file and initialize the ScreenMeet SDK.

```java
        ScreenMeet.init(this.getApplicationContext(), new ScreenMeet.Configuration("YOUR API KEY"));
        this.getApplication().registerActivityLifecycleCallbacks(ScreenMeet.activityLifecycleCallback());
```

![](https://cdn.document360.io/9da39725-20e5-434f-83a4-d630456099dc/Images/Documentation/image-1601571240099.png)

Congratulations!

At this point, the SDK is integrated into your app. If you would like to start a session, let's add some functionality to that button...

## Step 9 -- Show the session initiation dialog.

```java
                ScreenMeet.connect("YOUR SESSION CODE", new CompletionHandler() {
                    @Override
                    public void onSuccess() {
                        ScreenMeet.shareScreen();
                        ScreenMeet.shareAudio();
                    }

                    @Override
                    public void onFailure(@NotNull CompletionError completionError) {
                        //DO SOME ERROR HANDLING
                    }
                });
```

![](https://cdn.document360.io/9da39725-20e5-434f-83a4-d630456099dc/Images/Documentation/image-1622821371099.png)

Code Complete!

Your are now code complete! You just need to build/run the app on device or in the emulator.

## Running your HelloWorld app

When your run your app should now see the HelloWorld app:

![](https://cdn.document360.io/9da39725-20e5-434f-83a4-d630456099dc/Images/Documentation/image-1601572289449.png)

Input your session code and your app will now be streamed to the console on the other end.

## Next Steps...

Explore our [Android sample application](https://github.com/screenmeet/screenmeet-sdk-android-sample) to see some additional samples or visit our [API documentation](https://api-docs.screenmeet.com/android/3.0.0/index.html).