Official Android SDK for Stream Video

This is the official Android SDK for Stream Video, a service for building video calls, audio rooms, and live-streaming applications. This library includes both a low-level video SDK and a set of reusable UI components. Most users start with the Compose UI components and fall back to the lower-level API when they want to customize things.

🛥 What is Stream?

Stream allows developers to rapidly deploy scalable feeds, chat messaging and video with an industry leading 99.999% uptime SLA guarantee.

Stream provides UI components and state handling that make it easy to build video calling for your app. All calls run on Stream's network of edge servers around the world, ensuring optimal latency and reliability.

📕 Tutorials

With Stream's video components, you can use their SDK to build in-app video calling, audio rooms, audio calls, or live streaming. The best place to get started is with their tutorials:

• Video & Audio Calling Tutorial
• Audio Rooms Tutorial
• Livestreaming Tutorial

If you're interested in customizing the UI components for the Video SDK, check out the UI Cookbook.

📱 Previews

👔 Sample Projects

You can find sample projects below that demonstrates use cases of Stream Video SDK for Android:

• Demo App: Demo App demonstrates Stream Video SDK for Android with modern Android tech stacks, such as Compose, Hilt, and Coroutines.
• Android Video Samples: Provides a collection of samples that utilize modern Android tech stacks and Stream Video SDK for Kotlin and Compose.
• WhatsApp Clone Compose: WhatsApp clone project demonstrates modern Android development built with Jetpack Compose and Stream Chat/Video SDK for Compose.
• Twitch Clone Compose: Twitch clone project demonstrates modern Android development built with Jetpack Compose and Stream Chat/Video SDK for Compose.
• Meeting Room Compose: A real-time meeting room app built with Jetpack Compose to demonstrate video communications.
• Audio Only Demo: A sample implementation of an audio-only caller application with Android Video SDK.

👩‍💻 Free for Makers 👨‍💻

Stream is free for most side and hobby projects. To qualify, your project/company needs to have < 5 team members and < $10k in monthly revenue. Makers get $100 in monthly credit for video for free. For more details, check out the Maker Account.

💡Supported Features💡

Here are some of the features we support:

• Developer experience: Great SDKs, docs, tutorials and support so you can build quickly
• Edge network: Servers around the world ensure optimal latency and reliability
• Chat: Stored chat, reactions, threads, typing indicators, URL previews etc
• Security & Privacy: Based in USA and EU, Soc2 certified, GDPR compliant
• Dynascale: Automatically switch resolutions, fps, bitrate, codecs and paginate video on large calls
• Screensharing
• Picture in picture support
• Active speaker
• Custom events
• Geofencing
• Notifications and ringing calls
• Opus DTX & Red for reliable audio
• Webhooks & SQS
• Backstage mode
• Flexible permissions system
• Joining calls by ID, link or invite
• Enabling and disabling audio and video when in calls
• Flipping, Enabling and disabling camera in calls
• Enabling and disabling speakerphone in calls
• Push notification providers support
• Call recording
• Broadcasting to HLS

🗺️ Roadmap

Video roadmap and changelog is available here.

0.2.0 milestone

• [X] Publish app on play store
• [X] Example Button to switch speakerphone/earpiece (Jaewoong)
• [X] Chat Integration (Jaewoong)
• [X] Automatically handle pagination and sorting on > 6 participants in the sample app (Daniel)
• [X] Buttons to simulate ice restart and SFU switching (Jaewoong)
• [X] Bug: java.net.UnknownHostException: Unable to resolve host "hint.stream-io-video.com" isn't throw but instead logged as INFO (Daniel)
• [X] Bug: Call.join will throw an exception if error is other than HttpException
• [X] Report version number of SDK on all API calls (Daniel)
• [X] Bug: screensharing is broken. android doesn’t receive/render (not sure) the screenshare. video shows up as the gray avatar
• [X] support settings.audio.default_device (Daniel)
• [X] Bug: Sample app has a bug where we don't subscribe to call changes, we need to use call.get in the preview screen so we know the number of participants (Daniel)
• [X] Buttons to simulate ice restart and SFU switching (Jaewoong)
• [X] Local Video disconnects sometimes (ICE restarts issue for the publisher. we're waiting for the backend support) (Thierry)
• [X] Deeplink support for video call demo & dogfooding app (skip auth for the video demo, keep it for dogfooding) (Jaewoong)
• [X] XML version of VideoRenderer (Jaewoong)
• [X] sortedParticipants stateflow doesn't update accurately (Thierry)
• [X] Reactions
• [X] Bug: screenshare is not removed after it stops when a participant leaves the call (Thierry) (probably just dont update the state when the participant leaves)
• [X] Speaking while muted stateflow (Daniel)
• [X] Bluetooth reliability
• [X] Cleanup the retry behaviour in the RtcSession
• [X] SDK development guide for all teams

0.3.0 milestone

• [X] Finish usability testing with design team on chat integration (Jaewoong)
• [X] Pagination on query members & query call endpoints (Daniel)
• [X] Livestream tutorial (depends on RTMP support) (Thierry)
• [X] local version of audioLevel(s) for lower latency audio visualizations(Daniel)
• [X] Complete integration with the video demo flow
• [X] Pagination on query members & query call endpoints (Daniel)
• [X] Enable ice restarts for publisher and subscriber
• [X] Ringing: Finish it, make testing easy and write docs for common changes (Daniel)
• [X] Bug: Screensharing on Firefox has some issues when rendering on android (Daniel)
• [X] Bug: Screensharing scaling and zoom doesn't work (Daniel)

0.4.0 milestone

• [X] Screensharing from mobile
• [X] Picture of the video stream at the highest resolution + docs on how to add a button for this (Daniel)
• [X] Audio & Video filters. Support (Daniel)
• [X] Implement Chat overlay for Dogfooding (Jaewoong)
• [X] Migrate Stream Chat SDK v6 stable (Jaewoong)
• [X] Add Dogfooding instructions + directs Google Play (Jaewoong)
• [X] Support participant.custom field which was previously ignored. ParticipantState line 216 (Daniel)
• [X] Default livestream player UI + docs (Jaewoong)
• [X] Reaction dialog API for Compose (Jaewoong)
• [X] Android SDK development.md cleanup (Jaewoong)
• [X] Upgrade to more recent versions of webrtc (Jaewoong/Kanat)
• [X] Review foreground service vs backend for audio rooms etc. (Aleks)
• [X] Enable SFU switching
• [X] Support R8 full mode
• [ ] Logging is too verbose (rtc is very noisy), clean it up to focus on the essential for info and higher (Daniel)

0.5.0 milestone

• [X] Improve Compose UI SDK performance by marking WebRTC models as stable.
• [X] Development token to support a development environment

1.0.0 milestone - April

• [X] Blur & AI video filters
• [X] Analytics and stats for calls
• [X] New StreamCallActivity for easier integration

1.1.0 milestone - June

• [ ] Android Telecom framework integration
• [ ] Noise cancelling support
• [ ] Waiting rooms
• [ ] Session timers
• [ ] Closed Captions and multi language support for transcriptions

After 1.1 release

• [ ] Test coverage
• [ ] Dynascale 2.0 (depending backend support)
• [ ] Testing on more devices
• [ ] Camera controls
• [ ] Tap to focus
• [ ] Breakout rooms

Dynascale 2.0

• currently we support selecting which of the 3 layers you want to send: f, h and q. in addition we should support:
• changing the resolution of the f track
• changing the codec that's used from VP8 to h264 or vice versa
• detecting when webrtc changes the resolution of the f track, and notifying the server about it (if needed)

💼 We are hiring!

We've recently closed a \$38 million Series B funding round and we keep actively growing. Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world. Check out our current openings and apply via Stream's website.

License

Copyright (c) 2014-2024 Stream.io Inc. All rights reserved.

Licensed under the Stream License;
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   https://github.com/GetStream/stream-video-android/blob/main/LICENSE

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.