Merge branch 'main' of github.com:GetStream/stream-video-android

Author: tbarbugli

.github/workflows/compose-snapshot-docs.yml

@@ -25,6 +25,6 @@ jobs:
       - name: Deploy to GitHub pages
         uses: peaceiris/actions-gh-pages@v3
         with:
-          github_token: ${{ secrets.STREAM_CI_TOKEN }}
+          github_token: ${{ secrets.DOCUSAURUS_GH_TOKEN }}
           publish_dir: ./build/dokka/htmlMultiModule
           publish_branch: gh-pages

.github/workflows/release-docs.yaml

@@ -1,6 +1,6 @@
 # Official Android SDK for [Stream Video](https://getstream.io/video/docs/)
 
-// TODO - image for the SDK
+<img src=".readme-assets/Github-Graphic-Android.jpg" alt="Stream Video for Android Header image" style="box-shadow: 0 3px 10px rgb(0 0 0 / 0.2); border-radius: 1rem" />
 
 <p align="center">
   <a href="https://github.com/GetStream/stream-video-android/actions"><img src="https://github.com/GetStream/stream-video-android/workflows/App%20Distribute%20CI/badge.svg" /></a>
@@ -61,6 +61,8 @@ Video roadmap and changelog is available [here](https://github.com/GetStream/pro
 
 ### 0.2 milestone
 
+- [ ] bug: screensharing is broken. android doesn’t receive/render (not sure) the screenshare. video shows up as the gray avatar (Thierry)
+- [ ] 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)
 - [ ] Livestream tutorial
 - [ ] Deeplink support for video call demo & dogfooding app (skip auth for the video demo, keep it for dogfooding)
 - [ ] Chat Integration
@@ -75,7 +77,7 @@ Video roadmap and changelog is available [here](https://github.com/GetStream/pro
 - [ ] Test coverage
 - [ ] Testing on more devices
 - [ ] Speaking while muted stateflow
-- [ ] Audio & Video filters
+- [ ] Cleanup the retry behaviour in the RtcSession (see the TODO)
 - [ ] Android SDK development.md cleanup
 - [X] SDK development guide for all teams
 
@@ -85,4 +87,5 @@ Video roadmap and changelog is available [here](https://github.com/GetStream/pro
 - [ ] Screensharing from mobile
 - [ ] Tap to focus
 - [ ] Camera controls
+- [ ] Audio & Video filters
 - [ ] Picture of the video stream at highest resolution

.readme-assets/Github-Graphic-Android.jpg

@@ -6,7 +6,7 @@ object Configuration {
     const val minSdk = 24
     const val majorVersion = 0
     const val minorVersion = 0
-    const val patchVersion = 16
+    const val patchVersion = 17
     const val versionName = "$majorVersion.$minorVersion.$patchVersion"
     const val versionCode = 1
     const val snapshotVersionName = "$majorVersion.$minorVersion.${patchVersion}-SNAPSHOT"

README.md

@@ -1,21 +1,16 @@
 ---
-title: Video Call Tutorial
+title: How to Build an Android Video Calling App
 description: How to build a video call similar to Zoom or facebook messenger
 ---
 
 import { TokenSnippet } from '../../../shared/_tokenSnippet.jsx';
 
-
-Video Calling tutorial issues June 14th:
-
-* standalone join button (Jeroen)
-* review sessions with teams (Thierry)
-
 This tutorial teaches you how to build Zoom/Whatsapp style video calling for your app.
 
 * Calls run on Stream's global edge network for optimal latency & reliability.
 * Permissions give you fine grained control over who can do what.
 * Video quality and codecs are automatically optimized.
+* Powered by Stream's [Video Calling API](https://getstream.io/video/)
 
 ### Step 1 - Create a new project in Android Studio
 
@@ -33,10 +28,13 @@ If you're new to android, note that there are 2 `build.gradle` files, you want t
 
 ```groovy
 dependencies {
+    ...
     // Stream Video Compose SDK
-    implementation("io.getstream:stream-video-android-compose:0.0.16")
+    implementation("io.getstream:stream-video-android-compose:0.0.17")
+
+    ...
 
-    // Jetpack Compose
+    // Optionally add Jetpack Compose if Android studio didn't automatically include them
     implementation(platform("androidx.compose:compose-bom:2023.06.00"))
     implementation("androidx.activity:activity-compose:1.7.2")
     implementation("androidx.compose.ui:ui")
@@ -114,8 +112,8 @@ class MainActivity : ComponentActivity() {
 ```
 
 To run this sample we need a valid user token. The user token is typically generated by your server side API.
-So when the user logs in for your app you return the user token that gives them access to video calling.
-To make this tutorial easier to follow we'll generate a user token for you.
+So when the user logs in to your app your backend returns the user token that gives them access to video calling.
+To make this tutorial easier to follow we'll generate a user token for you:
 
 Please update **REPLACE_WITH_USER_ID**, **REPLACE_WITH_TOKEN** and **REPLACE_WITH_CALL_ID** with the actual values shown below:
 
@@ -219,7 +217,7 @@ setContent {
                     VideoRenderer(
                         modifier = Modifier.weight(1f),
                         call = call,
-                        video = remoteVideo?.value
+                        video = remoteVideo
                     )
                 }
             } else {
@@ -385,14 +383,14 @@ override fun onCreate(savedInstanceState: Bundle?) {
                                 ToggleCameraAction(
                                     modifier = Modifier.size(52.dp),
                                     isCameraEnabled = isCameraEnabled,
-                                    onCallAction = { call.camera.setEnabled(callAction.isEnabled) }
+                                    onCallAction = { call.camera.setEnabled(it.isEnabled) }
                                 )
                             },
                             {
                                 ToggleMicrophoneAction(
                                     modifier = Modifier.size(52.dp),
                                     isMicrophoneEnabled = isMicrophoneEnabled,
-                                    onCallAction = { call.microphone.setEnabled(callAction.isEnabled) }
+                                    onCallAction = { call.microphone.setEnabled(it.isEnabled) }
                                 )
                             },
                             {
@@ -431,19 +429,19 @@ VideoTheme(
 
 ### Recap
 
-Please do let us know if you ran into any issues.
+Please do let us know if you ran into any issues while building an video calling app with Kotlin.
 Our team is also happy to review your UI designs and offer recommendations on how to achieve it with Stream.
 
-To recap what we've learned:
+To recap what we've learned about android video calling:
 
 * You setup a call: (val call = client.call("default", "123"))
 * The call type ("default" in the above case) controls which features are enabled and how permissions are setup
 * When you join a call, realtime communication is setup for audio & video calling: (call.join())
 * Stateflow objects in call.state and call.state.participants make it easy to build your own UI
 * VideoRenderer is the low level component that renders video
 
-Calls run on Stream's global edge network of video servers.
+We've used Stream's [Video Calling API](https://getstream.io/video/), which means calls run on a global edge network of video servers.
 By being closer to your users the latency and reliability of calls are better.
-The SDKs enable you to build in-app video calling, audio rooms and livestreaming in days.
+The kotlin SDK enables you to build in-app video calling, audio rooms and livestreaming in days.
 
 We hope you've enjoyed this tutorial and please do feel free to reach out if you have any suggestions or questions.