From 4df6306142393239b0f98d330514866524c8d268 Mon Sep 17 00:00:00 2001 From: Yogesh Singh Date: Mon, 18 Nov 2024 16:46:26 +0530 Subject: [PATCH 1/3] updated docs --- .../plugins/effects-virtual-background.mdx | 8 ++++---- .../record-and-live-stream/hls/hls-player.mdx | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/javascript/v2/how-to-guides/extend-capabilities/plugins/effects-virtual-background.mdx b/docs/javascript/v2/how-to-guides/extend-capabilities/plugins/effects-virtual-background.mdx index dbb6978730..cbe0a8bdf5 100644 --- a/docs/javascript/v2/how-to-guides/extend-capabilities/plugins/effects-virtual-background.mdx +++ b/docs/javascript/v2/how-to-guides/extend-capabilities/plugins/effects-virtual-background.mdx @@ -3,15 +3,15 @@ title: Virtual Background with Effects SDK nav: 1.45 --- - - This feature is still in Beta. To know more or report any issues, feel free to reach out to us - over support@100ms.live. + + To know more or report any issues, feel free to reach out to us over support@100ms.live. +Virtual background plugin helps in customising the peer's background. The customising options are blurring the background or replacing it with a static image. This guide provides an overview of usage of the virtual background plugin of 100ms. ## Pre-requisites -**Get the 100ms VirtualBackground Package** (Supported since version 1.11.28) +Get the 100ms VirtualBackground Package (Supported since version 1.11.28) ```bash section=GetHMSVirtualBackgroundPackage sectionIndex=1 npm install --save @100mslive/hms-virtual-background@latest diff --git a/docs/javascript/v2/how-to-guides/record-and-live-stream/hls/hls-player.mdx b/docs/javascript/v2/how-to-guides/record-and-live-stream/hls/hls-player.mdx index 786f3192f1..2e498f1080 100644 --- a/docs/javascript/v2/how-to-guides/record-and-live-stream/hls/hls-player.mdx +++ b/docs/javascript/v2/how-to-guides/record-and-live-stream/hls/hls-player.mdx @@ -1,5 +1,5 @@ --- -title: HLS Player (Beta) +title: HLS Player nav: 1.32 --- @@ -314,7 +314,7 @@ hlsPlayer.on(HMSHLSPlayerEvents.PLAYBACK_STATE, playbackEventHandler); ## HLS Player example -Below is a simple example in which hls-player will be used in you app. +Below is a simple example in which hls-player will be used in your app. {' '} From cb165a336a4e7f05905b4d98a306dff25af857d8 Mon Sep 17 00:00:00 2001 From: Kaustubh Kumar Date: Tue, 19 Nov 2024 12:40:35 +0530 Subject: [PATCH 2/3] fix: update release notes (#2432) --- docs/android/v2/how-to-guides/install-the-sdk/size.mdx | 4 ++-- docs/javascript/v2/how-to-guides/debugging/faq.mdx | 4 ---- docs/javascript/v2/release-notes/release-notes.mdx | 4 ++++ 3 files changed, 6 insertions(+), 6 deletions(-) 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 index c4db0260a9..08d272cf4f 100644 --- a/docs/android/v2/how-to-guides/install-the-sdk/size.mdx +++ b/docs/android/v2/how-to-guides/install-the-sdk/size.mdx @@ -11,7 +11,7 @@ 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 | **10.2KB** | **10.2KB** | **10.2KB** | **10.2KB** | | Virtual Background | **15.4MB** | **12.9MB** | **4.0MB** | **4.0MB** | @@ -23,7 +23,7 @@ These are accurate for sdk version `2.9.64` and room-kit version `1.2.18`. ### Room Kit | Module Name | arm64-v8a | armeabi-v7 | x86 | x86_64 | -| -------------------|--------------|----------------|-----------|-------| +|-------------------|--------------|----------------|-----------|--------| | Room Kit | **12.4MB** | **11.4MB** | **13.0MB** | **13.3MB** | The `room-kit` module already includes the following libraries: diff --git a/docs/javascript/v2/how-to-guides/debugging/faq.mdx b/docs/javascript/v2/how-to-guides/debugging/faq.mdx index fe3123d3ae..8e1cc41801 100644 --- a/docs/javascript/v2/how-to-guides/debugging/faq.mdx +++ b/docs/javascript/v2/how-to-guides/debugging/faq.mdx @@ -165,10 +165,6 @@ The maximum allowed duration for a session on the 100ms platform is 12 hours. You can get the HLS URL in several ways based on whether you use 100ms client SDKs or a custom integration for playback; please check the [HLS guide](../../foundation/live-streaming#live-stream-playback) for more information. -#### I get type errors related to WebRTC Stats, for example, 'Cannot find name RTCInboundRtpStreamStats'. - -The supported version of TypeScript for the SDK is `4.7.4`. You could update to any version above 4.4 or if you are on an old version of TypeScript and cannot do a major upgrade you can set `skipLibCheck: true` in your tsconfig file. - #### Why is my screenshare not working on mobile browsers? The screenshare API(getDisplayMedia) is not yet supported on mobile browsers. Refer [this](https://caniuse.com/?search=getDisplayMedia) for supported browsers. diff --git a/docs/javascript/v2/release-notes/release-notes.mdx b/docs/javascript/v2/release-notes/release-notes.mdx index 211de421f2..76ccf7bfd8 100644 --- a/docs/javascript/v2/release-notes/release-notes.mdx +++ b/docs/javascript/v2/release-notes/release-notes.mdx @@ -28,6 +28,9 @@ description: Release Notes for 100ms JavaScript SDK | @100mslive/hms-noise-cancellation | 0.0.1 | | @100mslive/hms-virtual-background | 1.13.24 | +### Breaking +- Aspect ratio should be passed as string inside css for roomkit-react components + ### Added - Added a new field - `track_type` - in `HMSException` when there is a Track exception @@ -35,6 +38,7 @@ description: Release Notes for 100ms JavaScript SDK ### Fixed +- Newer Typescript versions are now supported - Tiles going out of view in recording for 480p resolution when there are more than 3 peers - Roomkit Prebuilt: Previous session's device selection not being preserved when Skip Preview was enabled - Roomkit Prebuilt: Peer stuck on loading screen after staying in preview for 15 mins instead of being redirected to the leave page From 0658fdccbac437d54e7c96274b6d5f77256405e0 Mon Sep 17 00:00:00 2001 From: KaustubhKumar05 Date: Tue, 19 Nov 2024 15:12:48 +0530 Subject: [PATCH 3/3] fix: revert table format --- docs/javascript/v2/release-notes/release-notes.mdx | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/docs/javascript/v2/release-notes/release-notes.mdx b/docs/javascript/v2/release-notes/release-notes.mdx index 76ccf7bfd8..73de0fe400 100644 --- a/docs/javascript/v2/release-notes/release-notes.mdx +++ b/docs/javascript/v2/release-notes/release-notes.mdx @@ -16,17 +16,7 @@ description: Release Notes for 100ms JavaScript SDK | @100mslive/hms-virtual-background | [![npm version](https://badge.fury.io/js/%40100mslive%2Fhms-virtual-background.svg)](https://badge.fury.io/js/%40100mslive%2Fhms-virtual-background) | -## 2024-11-11 - -| Package | Version | -| --------------------------------- | ------- | -| @100mslive/hms-video-store | 0.12.24 | -| @100mslive/react-sdk | 0.10.24 | -| @100mslive/roomkit-react | 0.3.24 | -| @100mslive/hms-whiteboard | 0.0.14 | -| @100mslive/hls-player | 0.3.24 | -| @100mslive/hms-noise-cancellation | 0.0.1 | -| @100mslive/hms-virtual-background | 1.13.24 | +Released: `@100mslive/hms-video-store@0.12.24`, `@100mslive/react-sdk@0.10.24`, `@100mslive/hls-player@0.3.24`, `@100mslive/roomkit-react@0.3.24`, `@100mslive/hms-whiteboard@0.0.14`, `@100mslive/hms-virtual-background@1.13.24` ### Breaking - Aspect ratio should be passed as string inside css for roomkit-react components