Skip to content

iamashiq/zoom-sdk-android

 
 

Repository files navigation

Zoom Android Software Development Kit (SDK)

Latest SDK Notifications

  1. Please add the following dependencies in your build.gradle file if you are using [v4.6.15086.0209]((https://github.com/zoom/zoom-sdk-android/releases/tag/v4.6.15086.0209) or later.
implementation 'androidx.appcompat:appcompat:1.0.0'
implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
implementation 'com.google.android.material:material:1.0.0-rc01'
  1. If you are using v4.4.55968.0904 (or later version), please ensure your compileSdkVersion and buildToolsVersion in your build.gradle file is 29+.

3.. 🔴 Non-AndroidX Version (EOL: 01/01/2020) Per Google's suggestions and guidance, we have upgraded our regular Android SDK to support AndroidX. We understand that upgrading an existing Android project/product to AndroidX would need some time, and we heard your feedback. We hereby offer an Android SDK version that does not require AndroidX, you may find it (android-mobilertc_support_xxx.zip ) here: https://github.com/zoom/zoom-sdk-android/releases The end-of-life date of offering and supporting this version will be 01/01/2020. Please use this version if you are not able to upgrade your project to AndroidX at the moment. Please plan to upgrade your Android project to AndroidX before 01/01/2020.

  1. Android 64-bit support is now available in the release v4.4.55130.0712., please don't forget to upgrade your Android project to be a AndroidX project.
  2. Variable Name Changes: Since v4.3.1.47200.0322, we have renamed the term "APP" to "SDK" in our demo to avoid confusion between the term "API" and "APP".
  3. Please be aware that some of our interfaces are deprecated in the latest release, please check out our CHANGELOG for more detail
  4. Encounter with issues? The answer might be waiting for you at Frequently Asked Questions sections.
  5. Our brand new Zoom Developer Community Forum is now online!!! Check it out! We are here to help! :D

Full Documentation && Community Support

You can find the full Zoom Android SDK documentation and the community support forum here:

What is Zoom Android SDK?

Zoom SDK makes it easy to integrate Zoom with your Android applications, and boosts up your applications with the power of Zoom.

  • Easy to use: Our SDK is built to be easy to use. Just import the libraries, call a few functions, and we will take care all video conferencing related stuffs for you.
  • Localizable: Our SDK naturally supports 7 major languages, and you can add more to grow your applications internationally.
  • Custom Meeting UI: If you want to add your own decorations to your Zoom meeting rooms, try our Custom UI feature to make your meeting room special.

Disclaimer

Please be aware that all hard-coded variables and constants shown in the documentation and in the demo, such as Zoom Token, Zoom Access, Token, etc., are ONLY FOR DEMO AND TESTING PURPOSES. We STRONGLY DISCOURAGE the way of HARDCODING any Zoom Credentials (username, password, API Keys & secrets, SDK keys & secrets, etc.) or any Personal Identifiable Information (PII) inside your application. WE DON’T MAKE ANY COMMITMENTS ABOUT ANY LOSS CAUSED BY HARD-CODING CREDENTIALS OR SENSITIVE INFORMATION INSIDE YOUR APP WHEN DEVELOPING WITH OUR SDK.

Getting Started

The following instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Before you try out our SDK, you would need the following to get started:

  • A Zoom Account: If you do not have one, you can sign up at https://zoom.us/signup.
  • An Android device:
    • OS: Android 4.0 (API Level 14) or later.
    • CPU: armeabi-v7a, x86, armeabi, arm64-v8a, x86_64

Installing

Clone or download a copy of our SDK files from GitHub. After you unzipped the file, you should have the following folders:

.
├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── docs
├── [mobilertc-android-studio] <- Libraries and examples are inside.
├── proguard.cfg
└── version.txt

Launch your Android Studio, navigate to the "mobilerte-android-studio" folder, and open it.

Once the project is fully loaded, you will see the following structure:

.
├── build.gradle
├── commonlib
├── example2
├── gradle
├── gradlew
├── gradlew.bat
├── mobilertc
├── sample
└── settings.gradle

We provide 2 different examples for you:

  • sample: An Android app that has all basic features for both login users and non-login users.
  • example2: An Android app that shows how to join meeting without any login credentials.

In sample app, we provide detailed examples of how to implement each feature, which could be very helpful when you are integrating Zoom SDK into your app. Here are the categories of the code sample that we offer

.
├── initsdk
├── inmeetingfunction
│   ├── customizedmeetingui
│   │   ├── audio
│   │   ├── other
│   │   ├── remotecontrol
│   │   ├── share
│   │   ├── user
│   │   ├── video
│   │   └── view
│   │       ├── adapter
│   │       └── share
│   └── zoommeetingui
├── otherfeatures
│   └── scheduleforloginuser
├── startjoinmeeting
│   ├── apiuser
│   ├── emailloginuser
│   ├── joinmeetingonly
│   └── ssologinuser
└── ui

Running the examples

Connect your Android device to your computer and simply press "Run" on selected example, the example will run on your device.

Documentation

Please visit [https://marketplace.zoom.us/docs/sdk/native-sdks/android] for details of each features and functions.

SDK Reference

You may find the SDK interface reference at https://marketplace.zoom.us/docs/sdk/native-sdks/android/sdk-reference. If you would like to get a local copy of the SDK reference, you may download it here.

Versioning

For the versions available, see the tags on this repository.

Change log

Please refer to our CHANGELOG for all changes.

Frequently Asked Questions (FAQ)

  • 1️⃣ Emulator is not working:
    • SDK releases before v4.3.53571.0118 only supports emulators with ABI arm series(armeabi-v7a, arm64-v8a). Starting from v4.3.53571.0118, both arm series(armeabi-v7a, arm64-v8a) and x86 ABI are supported.
  • 2️⃣ java.lang.NoClassDefFoundError: Failed resolution of: Landroidx/fragment/app/FragmentActivity:
    • The Zoom SDK has adapted AndroidX since the release v4.4.55130.0712, if you have not migrated your project to be a AndroidX project, you will receive the above error message. Upgrading your Android project to be a AndroidX project will fix this issue.
  • Not finding what you want? We are here to help! Please visit our Zoom Developer Community Forum for further assistance.

Support

For any issues regarding our SDK, please visit our new Community Support Forum at https://devforum.zoom.us/.

License

Please refer to LICENSE.md file for details

Acknowledgments

  • ⭐ If you like our SDK, please give us a "Star". Your support is what keeps us moving forward and delivering happiness to you! Thanks a million! 😃
  • If you need any support or assistance, we are here to help you: Zoom Developer Community Forum;

Copyright ©2020 Zoom Video Communications, Inc. All rights reserved.

Packages

No packages published

Languages

  • Java 100.0%