Release PR (#2342)

* Fix remove old video subscribe doc (#2332) * 1.14.1 iOS Release (#2329) * Update auto-video-degrade-restore.mdx --------- Co-authored-by: ygit <[email protected]> Co-authored-by: Dmitry Fedoseyev <[email protected]> * Android pre call diagnostic docs (#2331) * 1.14.1 iOS Release (#2329) * Added pre call diagnostic docs * Update pre-call-diagnostics.mdx * Update pre-call-diagnostics.mdx * fix syntax * Added code tabs * Updated to new HMSDiagnostic class name * Fixed typos --------- Co-authored-by: ygit <[email protected]> Co-authored-by: Dmitry Fedoseyev <[email protected]> Co-authored-by: Gulzar <[email protected]> * added VB prebuilt docs (#2335) * Android API reference docs PR (#2338) * 1.14.1 iOS Release (#2329) * 1.15.0 iOS Release (#2334) * Updating the API reference for SDK version --------- Co-authored-by: ygit <[email protected]> Co-authored-by: Dmitry Fedoseyev <[email protected]> Co-authored-by: Aniket Kadam <[email protected]> * Release notes android v2.9.64 (#2339) Fixed typos * fix: web release notes * docs(web): update api reference * fix * fix: review comments * updated Event listener docs (#2343) * AN-1673: vb/nc docs (#2344) * Add search for peers info to large room * Add VB for room kit as well * Consolidate how prebuilt version is declared * Mention prebuilt in NC docs * More detail * Update code indications so it doesn't spell check. * Update limits * Size docs for android (#2345) Adding size docs for versions * fix: max peers query limit --------- Co-authored-by: Gulzar <[email protected]> Co-authored-by: ygit <[email protected]> Co-authored-by: Dmitry Fedoseyev <[email protected]> Co-authored-by: Pratim Mallick <[email protected]> Co-authored-by: Jatin Nagar <[email protected]> Co-authored-by: Aniket Kadam <[email protected]> Co-authored-by: KaustubhKumar05 <[email protected]> Co-authored-by: KaustubhKumar05 <[email protected]>
100mslive · Jul 25, 2024 · 7552986 · 7552986
1 parent 959cb82
commit 7552986
Show file tree

Hide file tree

Showing 12 changed files with 285 additions and 69 deletions.
diff --git a/common/android-prebuilt-version-shield.md b/common/android-prebuilt-version-shield.md
@@ -0,0 +1 @@
+[![](https://img.shields.io/badge/dynamic/xml.svg?label=100ms-Prebuilt&color=blue&query=%2F%2Fmetadata%2Fversioning%2Flatest&url=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Flive%2F100ms%2Froom-kit%2Fmaven-metadata.xml)](https://jitpack.io/#100mslive/room-kit)
diff --git a/docs/android/v2/how-to-guides/extend-capabilities/noise-cancellation.mdx b/docs/android/v2/how-to-guides/extend-capabilities/noise-cancellation.mdx
@@ -14,6 +14,9 @@ implementation "live.100ms:hms-noise-cancellation-android:$hmsVersion"
 ```
 2. Toggle noise cancellation on in your application with `hmsSDK.setNoiseCancellationEnabled(true)` in your `onJoin` callback.
 
+> Note: Prebuilt also supports noise cancellation, to enable it add the import as above and ensure it's enabled from your prebuilt dashboard. From the [dashboard](https://dashboard.100ms.live/), select the template, go to "Customize Prebuilt" -> "Screens and Components" -> "Noise Cancellation State".
+> You will also need to toggle it in the [dashboard's](https://dashboard.100ms.live/)"Template" -> "Advanced Settings" -> "Noise Cancellation"
+
 > Note: Adding the library for noise cancellation will increase app size by 5.6 Mb.  
 Noise cancellation is turned off by default for all calls.
 

diff --git a/docs/android/v2/how-to-guides/extend-capabilities/plugins/virtual-background.mdx b/docs/android/v2/how-to-guides/extend-capabilities/plugins/virtual-background.mdx
@@ -4,6 +4,7 @@ nav: 14.3
 ---
 
 import AndroidSdkVersionShield from '@/common/android-sdk-version-shield.md';
+import AndroidPrebuiltVersionShield from '@/common/android-prebuilt-version-shield.md';
 
 ## Introduction
 
@@ -14,20 +15,22 @@ This guide provides an overview of usage of the Virtual Background Plugin of 100
 ## Supported Versions/Resolutions
 
 -   Minimum 100ms SDK version it can work with is `2.9.58`
+-   Minimum 100ms Room Kit version it can work with is `1.2.18`
 -   Has poor fps on older android phones
 
 
 ## Add dependency
 
+### If not using room kit:
 Adding the Virtual Background plugin and SDK dependency to your app-level `build.gradle`.
 
-<AndroidSdkVersionShield />
-
-<Tabs id="sdk-imports" items={['Maven Central']} />
+<Tabs id="sdk-imports" items={['SDK integration','With Prebuilt']} />
 
 <Tab id='sdk-imports-0'>
 
-```json{5-8}:build.gradle section=AddSDKDependencies sectionIndex=1
+<AndroidSdkVersionShield />
+
+```json:build.gradle section=AddSDKDependencies sectionIndex=1
 dependencies {
  // See the version in the badge above.
 
@@ -39,6 +42,26 @@ dependencies {
 
 </Tab>
 
+<Tab id='sdk-imports-1'>
+
+<AndroidSdkVersionShield />
+<AndroidPrebuiltVersionShield />
+
+```json:build.gradle section=AddSDKDependencies sectionIndex=1
+dependencies {
+ // See the version in the badge above.
+
+ def hmsVersion = "x.x.x" // 100ms
+ def roomKitVersion = "x.x.x" // 100ms-Prebuilt
+ implementation "live.100ms:room-kit:$roomKitVersion"    // Essential
+ implementation "live.100ms:virtual-background:$hmsVersion" 
+}
+```
+
+</Tab>
+
+## In Prebuilt/RoomKit
+Enable it from the dashboard, go to Customize Prebuilt -> Screens and Components -> (scroll down the left pane) Virtual Background.
 
 ## How to Integrate Virtual Background Plugin:
 

diff --git a/docs/android/v2/how-to-guides/install-the-sdk/size.mdx b/docs/android/v2/how-to-guides/install-the-sdk/size.mdx
@@ -6,25 +6,25 @@ Each library has its own size impact that can vary been ABIs (x86, arm64-v8a etc
 
 You can take a look at the reference project [here](https://github.com/100mslive/Android-Size-Reference-App/)
 
-These are accurate for sdk version `2.9.62` and room-kit version `1.2.15`.
+These are accurate for sdk version `2.9.64` and room-kit version `1.2.18`.
 
 ## Increase in Android APK size:
 
 |  Module Name     	|  arm64-v8a   |	armeabi-v7	|	x86		| x86_64 |
 | -------------------|--------------|----------------|-----------|-------|
 | Android Sdk 	| **6.7MB**	|	**5.7MB**  	|	**7.3MB**	| 	**7.6MB** 	|
-| Video View 	| **8.8KB**	|	**8.8KB**  	|	**8.8KB**	| 	**8.8KB** 	|
+| Video View 	| **10.2KB**	|	**10.2KB**  	|	**10.2KB**	| 	**10.2KB** 	|
 | Virtual Background 	| **15.4MB**	|	**12.9MB**  	|	**4.0MB**	| 	**4.0MB** 	|
 | Noise Cancellation 	| **5.6MB**	|	**5.6MB**  	|	**5.6MB**	| 	**5.6MB** 	|
-| Video Filters 	| **22.5KB**	|	**26.9KB**  	|	**22.5KB**	| 	**23.0KB** 	|
-| Hls Player 	| **958.1KB**	|	**958.1KB**  	|	**958.1KB**	| 	**958.1KB** 	|
-| Hls Player Stats 	| **464.0KB**	|	**464.0KB**  	|	**464.0KB**	| 	**464.0KB** 	|
+| Video Filters 	| **20.0KB**	|	**24.3KB**  	|	**20.0KB**	| 	**20.5KB** 	|
+| Hls Player 	| **957.9KB**	|	**957.9KB**  	|	**957.9KB**	| 	**957.9KB** 	|
+| Hls Player Stats 	| **463.8KB**	|	**463.8KB**  	|	**463.8KB**	| 	**463.8KB** 	|
 
 ### Room Kit
 
 |  Module Name     	|  arm64-v8a   |	armeabi-v7	|	x86		| x86_64 |
 | -------------------|--------------|----------------|-----------|-------|
-| Room Kit 	| **11.1MB**	|	**10.4MB**  	|	**11.9MB**	| 	**12.0MB** 	|
+| Room Kit 	| **12.4MB**	|	**11.4MB**  	|	**13.0MB**	| 	**13.3MB** 	|
 
 The `room-kit` module already includes the following libraries:
 - `android-sdk`

diff --git a/docs/android/v2/how-to-guides/interact-with-room/peer/large-room.mdx b/docs/android/v2/how-to-guides/interact-with-room/peer/large-room.mdx
@@ -134,3 +134,34 @@ You use **totalCount** property on **HMSPeerListIterator** to know how many peer
 ```kotlin
 let totalPeerCount = peerListIterator.totalCount
 ```
+
+### Search for peers
+To just search for peers without getting all of them use:
+```kotlin
+HMSSDK.searchPeerNameInLargeRoomsearchPeerNameInLargeRoom(
+    query: String,
+    limit: Int,
+    offset: Long,
+    listener: HmsTypedActionResultListener<PeerSearchResponse>) {
+```
+* query - substring of the peer's name that you want to search for.
+* limit - the number of peers you want returned for this query, max 100
+* offset - when looking for more peers than the max limit, send an offset for the next set.
+* listener: will return `PeerSearchResponse` in the onSuccess callback in this interface.
+
+```kotlin
+data class PeerSearchResponse(
+    val eof: Boolean
+    val offset: Long
+    val count: Long
+    val limit: Int
+    val peers: List<HMSPeer>
+)
+```
+The peer search response contains:
+* `eof` - true if there are no more results, false otherwise.
+* `offset` - the offset requested.
+* `count` - the number of results.
+* `limit` - the limit that was given, max 100.
+* `peers` - the list of `HMSPeer` that match the search query.
+
diff --git a/docs/android/v2/release-notes/release-notes.mdx b/docs/android/v2/release-notes/release-notes.mdx
@@ -4,13 +4,13 @@
  description: Release Notes for 100ms Android
 ---
 import AndroidSdkVersionShield from '@/common/android-sdk-version-shield.md';
+import AndroidPrebuiltVersionShield from '@/common/android-prebuilt-version-shield.md';
 
 ## Latest Versions
 
 | Package                                | Version                                                                                                                                |
 | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
-| live.100ms:room-kit             | [![](https://img.shields.io/badge/dynamic/xml.svg?label=100ms-Prebuilt&color=blue&query=%2F%2Fmetadata%2Fversioning%2Flatest&url=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Flive%2F100ms%2Froom-kit%2Fmaven-metadata.xml)](https://jitpack.io/#100mslive/room-kit)
-|
+| live.100ms:room-kit             | <AndroidPrebuiltVersionShield/> |
 | live.100ms:android-sdk:                   |  <AndroidSdkVersionShield />  |
 | live.100ms:video-view:               |   <AndroidSdkVersionShield />  |
 | live.100ms:hls-player:                  |<AndroidSdkVersionShield />            |

diff --git a/docs/api-reference/javascript/v2/home/content.md b/docs/api-reference/javascript/v2/home/content.md
@@ -1302,7 +1302,7 @@ Select the track ID of your local peer's primary audio track
 ▸ **selectLocalMediaSettings**(`store`): [`HMSMediaSettings`](/api-reference/javascript/v2/interfaces/HMSMediaSettings)
 
 Select your media settings
-i.e., choosen audio input device, audio output device and video input device.
+i.e., choosen audio input device, audio output device and video input device, audio mode
 
 #### Parameters
 

diff --git a/docs/api-reference/javascript/v2/interfaces/HMSConfigInitialSettings.md b/docs/api-reference/javascript/v2/interfaces/HMSConfigInitialSettings.md
@@ -11,6 +11,12 @@ nav: '4.18'
 
 ---
 
+### audioMode
+
+• `Optional` **audioMode**: [`HMSAudioMode`](/api-reference/javascript/v2/enums/HMSAudioMode)
+
+---
+
 ### audioOutputDeviceId
 
 • `Optional` **audioOutputDeviceId**: `string`

diff --git a/docs/api-reference/javascript/v2/interfaces/HMSMediaSettings.md b/docs/api-reference/javascript/v2/interfaces/HMSMediaSettings.md
@@ -11,6 +11,12 @@ nav: '4.31'
 
 ---
 
+### audioMode
+
+• `Optional` **audioMode**: [`HMSAudioMode`](/api-reference/javascript/v2/enums/HMSAudioMode)
+
+---
+
 ### audioOutputDeviceId
 
 • `Optional` **audioOutputDeviceId**: `string`

diff --git a/docs/api-reference/javascript/v2/react-hooks/home/content.md b/docs/api-reference/javascript/v2/react-hooks/home/content.md
@@ -199,6 +199,21 @@ An e.g. use of this hook will be to apply box-shadow on parent tile based on aud
 
 ---
 
+### useAudioMode
+
+▸ **useAudioMode**(): `Object`
+
+#### Returns
+
+`Object`
+
+| Name                 | Type                     |
+| :------------------- | :----------------------- |
+| `isMusicModeEnabled` | `boolean`                |
+| `toggleMusicMode`    | () => `Promise`<`void`\> |
+
+---
+
 ### useAutoplayError
 
 ▸ **useAutoplayError**(): [`useAutoplayErrorResult`](/api-reference/javascript/v2/react-hooks/interfaces/useAutoplayErrorResult)

diff --git a/docs/javascript/v2/release-notes/release-notes.mdx b/docs/javascript/v2/release-notes/release-notes.mdx
@@ -15,6 +15,42 @@ description: Release Notes for 100ms JavaScript SDK
 | @100mslive/hms-noise-cancellation      | [![npm version](https://badge.fury.io/js/%40100mslive%2Fhms-noise-cancellation.svg)](https://badge.fury.io/js/%40100mslive%2Fhms-noise-cancellation)           |
 | @100mslive/hms-video-react(deprecated) | [![npm version](https://badge.fury.io/js/%40100mslive%2Fhms-video-react.svg)](https://badge.fury.io/js/%40100mslive%2Fhms-video-react) |
 
+## 2024-07-22
+
+Released: `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`
+
+### Added:
+- Roomkit Prebuilt: PIP chat 
+- Roomkit Prebuilt: Switch role option for local peer if permission is present
+- Roomkit Prebuilt: Sort handraise in participant list - first one to raise hand will be shown first
+- Roomkit Prebuilt: Hand raise notification when the call tab is inactive
+
+### Fixed:
+- Roomkit Prebuilt: Flip camera shown for Firefox on desktop
+
+## 2024-07-10
+
+Released: `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`
+
+### Added:
+- `useAudioMode` custom hook to manage audio mode. Can be selected from the store using `selectLocalMediaSettings` 
+
+### Fixed:
+- Roomkit Prebuilt: Rejoining after role change persists the last layout instead of honoring the roomcode
+- Roomkit Prebuilt: Mweb inset tile hidden during screenshare
+
+## 2024-06-25
+
+Released: `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`
+
+### Added:
+- Pre call diagnostics support
+- Roomkit Prebuilt: Pre call diagnostics
+- Music mode
+
+### Fixed:
+- Roomkit Prebuilt: Limited chat message length to prevent abuse
+
 ## 2024-06-14
 Released: `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		[![](https://img.shields.io/badge/dynamic/xml.svg?label=100ms-Prebuilt&color=blue&query=%2F%2Fmetadata%2Fversioning%2Flatest&url=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Flive%2F100ms%2Froom-kit%2Fmaven-metadata.xml)](https://jitpack.io/#100mslive/room-kit)