https://github.com/zoom/videosdk-android-quickstart
https://github.com/zoom/videosdk-android-quickstart
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/zoom/videosdk-android-quickstart
- Owner: zoom
- Created: 2025-06-04T14:46:43.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-09-11T23:42:52.000Z (6 months ago)
- Last Synced: 2025-09-12T01:54:46.155Z (6 months ago)
- Language: Kotlin
- Size: 144 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Video SDK Android Quickstart
This is a Sample App of the Android Zoom Video SDK using Jetpack Compose. Compose is a popular, modern UI toolkit from Android for building native Android UIs with Kotlin. With the use of this app, developers can quickly start
their Zoom Video SDK projects, integrate the SDK into their projects, or use as reference for best coding practices for our Android Video SDK.
Use of this Sample App is subject to our [Terms of Use](https://www.zoom.com/en/trust/terms/).
You can find the corresponding Developer Blog for this app [here](https://developers.zoom.us/blog/videosdk-android-quickstart/)
## Installation
Clone this repo into your local enviroment:
```
$ git clone https://github.com/zoom/VideoSDK-Android-Quickstart.git
```
Once cloned, navigate to the 'videosdk-android-quickstart' directory
You can use the `studio .` command to open it in Android Studio.
In the `env-sample` file found in `app/src/main/assets`, you can either enter a enter your SDK Credentials from Marketplace to use the local Token Generator or enter an Endpoint URL of a server of your choice, which the app will use to query for a JWTToken. Once your data is entered, rename this file to `env`.
> :warning: **Do not store credentials in plain text on production environments**
## Configuration
If you use the apps APIClient, the request query parameters and body structure can be edited to match your servers requirements in the `ApiService.kt` file. The current request structure is as follows:
```
curl --location --request POST 'http://ENDPOINT_URL/zoomtoken?token=&name=&password=' \
--header 'Content-Type: application/json' \
--data '{
"body": {
"sessionName" = "",
"role" = 0,
"userIdentity" = "",
"sessionkey" = "",
"geo_regions" = "",
"cloud_recording_option" = 0,
"cloud_recording_election" = 0,
"telemetry_tracking_id" = "",
"video_webrtc_mode" = 0,
"audio_webrtc_mode" = 0
}
}'
```
## Usage
After entering either a JWTToken or Endpoint URL and configuring your Endpoint, you can start the Sample App by clicking Build and Run!
