Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release PR #2079

Merged
merged 122 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
122 commits
Select commit Hold shift + click to select a range
2abb0ef
Sync QA (#1848)
saikatmitra91 Nov 7, 2023
d578886
Qa main backmerge 2 (#1855)
hdz-666 Nov 8, 2023
ec9b1ec
Merge branch 'main' into qa
hdz-666 Nov 8, 2023
eb69449
fix: typos (#1850) (#1856)
hdz-666 Nov 8, 2023
e8e5bb0
Backmerge main to QA (#1891)
KaustubhKumar05 Dec 6, 2023
85df7f2
Update qa (#1917)
KaustubhKumar05 Dec 18, 2023
726c48c
fix: sidebar rendering in examples pages (#1916)
KaustubhKumar05 Dec 18, 2023
3378802
Revert sidebar changes (#1918)
KaustubhKumar05 Dec 18, 2023
159079a
Fix link fetching (#1919)
KaustubhKumar05 Dec 18, 2023
c21157a
Merge branch 'main' into qa
KaustubhKumar05 Dec 18, 2023
3744078
Update QA (#1924)
KaustubhKumar05 Dec 20, 2023
18c8101
migration guide update for android and ios (#1923)
mntrspace Dec 20, 2023
16c8ac3
Update qa w main (#1927)
KaustubhKumar05 Dec 20, 2023
fd009db
Main to QA backmerge (#1928)
AnkitRastogi3 Dec 20, 2023
8f7e11e
Merge branch 'main' into qa
hdz-666 Dec 21, 2023
96388c9
HMS-7303 (#1931)
vivekd-100ms Dec 22, 2023
d489b64
add room_name and recording_id in webhooks (#1905)
pratishbodhale Dec 23, 2023
795e860
Merge branch 'main' into qa
KaustubhKumar05 Dec 26, 2023
ae51521
live transcription doc (#1922)
mntrspace Dec 26, 2023
c2e25ef
updated PIP docs (#1934)
ygit Dec 27, 2023
5a512ae
1.4.2 iOS Release (#1935)
gzerad Jan 4, 2024
e5c1ff9
Added jsx to accept.txt (#1944)
mntrspace Jan 9, 2024
326318d
Updates to post call transcription guide, rtmp ingestion guide, live …
mntrspace Jan 9, 2024
fb552ce
Security and compliance (#1946)
mntrspace Jan 10, 2024
0ab95e6
fix: vale version (#1949)
KaustubhKumar05 Jan 10, 2024
dbf2eb4
Merge branch 'main' into qa
KaustubhKumar05 Jan 10, 2024
d3b245d
Main to QA backmerge (#1953)
KaustubhKumar05 Jan 12, 2024
2505361
5 Jan web release notes (#1945)
KaustubhKumar05 Jan 12, 2024
e36ad88
virtual background (#1937)
akankshat100ms Jan 16, 2024
6d972b4
Merge branch 'main' into qa
KaustubhKumar05 Jan 16, 2024
3884e45
Virtual background (#1960)
akankshat100ms Jan 17, 2024
4b5bec1
fix: update (#1962)
KaustubhKumar05 Jan 18, 2024
755d398
Merge branch 'main' into qa
KaustubhKumar05 Jan 18, 2024
3fecca2
docs(web): update api reference (#1965)
s-dvd Jan 19, 2024
47f7719
Merge branch 'main' into qa
KaustubhKumar05 Jan 19, 2024
0bdde97
Web release notes 1901 (#1967)
KaustubhKumar05 Jan 19, 2024
2022114
remove redundant vb file (#1969)
KaustubhKumar05 Jan 22, 2024
fa86a5f
docs: 25 Jan 2024 web release notes
raviteja83 Jan 29, 2024
da7ca34
docs: update
raviteja83 Jan 29, 2024
aae54b9
SS-3421 : Added suggested blogs component (#1959)
AnkitRastogi3 Jan 29, 2024
87dfbbf
SS-3634 : Moved prebuilt from overview and added in sidebar list (#1974)
AnkitRastogi3 Jan 30, 2024
26a72d1
SS: 3634 updates (#1975)
AnkitRastogi3 Jan 30, 2024
867a406
Docs release PR (#1980)
KaustubhKumar05 Feb 2, 2024
ac4927d
fix modes in template request
pratishbodhale Feb 7, 2024
8fbe54b
Ss 3637 (#1977)
AnkitRastogi3 Feb 9, 2024
9f26ea1
Merge branch 'main' into qa
KaustubhKumar05 Feb 12, 2024
137c880
Ss 3637 - handling hash (#1996)
AnkitRastogi3 Feb 12, 2024
b250d25
HMS-8358 (#2000)
vivekd-100ms Feb 14, 2024
f205f82
removed dummy blogs (#1986)
AnkitRastogi3 Feb 14, 2024
c494d0f
list query params (#1988)
KaustubhKumar05 Feb 14, 2024
c07f910
Merge branch 'main' into qa
KaustubhKumar05 Feb 14, 2024
4575fe0
User context (#2003)
akankshat100ms Feb 15, 2024
88e700d
Roomauth (#2004)
akankshat100ms Feb 15, 2024
eddb6a6
Roomauth (#2005)
akankshat100ms Feb 16, 2024
a77e4d3
Update adaptive-bitrate.md (#1884)
mntrspace Feb 16, 2024
730a3a4
Update qa (#2007)
KaustubhKumar05 Feb 16, 2024
bf380a7
Qa backmerge (#2008)
KaustubhKumar05 Feb 16, 2024
dd8bca0
Merge branch 'main' into qa
KaustubhKumar05 Feb 16, 2024
0dae993
fix: update HMSQuizLeaderboard (#1939)
KaustubhKumar05 Feb 16, 2024
36cf44c
docs: add web release notes
raviteja83 Feb 19, 2024
a02511f
Merge branch 'main' into qa
KaustubhKumar05 Feb 20, 2024
c309f3f
Migration guide update 20feb2024 (#2021)
mntrspace Feb 22, 2024
b092bfd
Hipaa compliance 20feb2024 (#2022)
mntrspace Feb 22, 2024
232dd12
Merge branch 'main' into qa
KaustubhKumar05 Feb 22, 2024
e87d6e0
Effects VB integration doc (#1990)
KaustubhKumar05 Feb 22, 2024
12bca85
Automation workflows (#2024)
KaustubhKumar05 Feb 22, 2024
a85ec55
Hipaa updates 22feb2024 (#2026)
mntrspace Feb 22, 2024
3f028f7
Merge branch 'main' into qa
mntrspace Feb 23, 2024
ab94791
docs(web): update api reference (#2027)
s-dvd Feb 23, 2024
c3fc4b7
Backmerge PR (#2030)
KaustubhKumar05 Feb 23, 2024
9098bf9
Merge branch 'main' into qa
KaustubhKumar05 Feb 23, 2024
845ff56
Release notes 2024-02-23 (#2032)
KaustubhKumar05 Feb 26, 2024
e0a8907
Peerinsights (#2014)
akankshat100ms Feb 26, 2024
5a85d56
Update peerinsights.mdx
akankshat100ms Feb 26, 2024
69eaaf9
Merge branch 'main' into qa
KaustubhKumar05 Feb 26, 2024
0123f72
fix: release automation actions (#2034)
KaustubhKumar05 Feb 26, 2024
b8b4fcd
Merge branch 'main' into qa
KaustubhKumar05 Feb 26, 2024
70518f8
fix: tags in release notes (#2036)
KaustubhKumar05 Feb 26, 2024
0c81e9e
fix: tags for subheading
KaustubhKumar05 Feb 26, 2024
a4a0c2a
Sip and hipaa updates 27feb2024 (#2045)
mntrspace Feb 28, 2024
b3b5f86
Merge branch 'main' into qa
KaustubhKumar05 Feb 28, 2024
5d0f290
SS-3439 : support all react-icons in Callout (#2044)
AnkitRastogi3 Mar 1, 2024
64ff69a
New recordings (#2031)
akankshat100ms Mar 4, 2024
556ec34
Merge branch 'main' into qa
KaustubhKumar05 Mar 4, 2024
dd3887f
fix: icons for callout component (#2050)
KaustubhKumar05 Mar 4, 2024
faad040
fix: closing tag for flexcontainer
KaustubhKumar05 Mar 4, 2024
ac9467e
Merge branch 'qa' of https://github.com/100mslive/100ms-docs into qa
KaustubhKumar05 Mar 4, 2024
2030ad7
Fix recording mode description in the overview. (#2051)
rtpriya Mar 4, 2024
8c75464
Merge open prs (#2052)
KaustubhKumar05 Mar 4, 2024
21c19cd
Added poll methods (#2048)
Decoder07 Mar 4, 2024
e9feb95
Merge branch 'main' into qa
ygit Mar 4, 2024
5e7d23b
Updated release notes (#2049)
Decoder07 Mar 4, 2024
efe91e4
fix: links
KaustubhKumar05 Mar 4, 2024
618919d
backmerge: main to qa (#2055)
github-actions[bot] Mar 4, 2024
b06db63
Merge branch 'main' into qa
KaustubhKumar05 Mar 4, 2024
6e00099
fix: links (#2057)
KaustubhKumar05 Mar 5, 2024
d0c7334
fix: links (#2059)
KaustubhKumar05 Mar 5, 2024
62d9aa5
Merge branch 'main' into qa
KaustubhKumar05 Mar 5, 2024
6ccd2c9
fix: link
KaustubhKumar05 Mar 5, 2024
d1e4f8a
docs: 05 Mar web release notes (#2063)
raviteja83 Mar 5, 2024
a3eab3b
docs(web): update api reference (#2062)
s-dvd Mar 5, 2024
1e983e1
backmerge: main to qa (#2064)
github-actions[bot] Mar 5, 2024
8e9b9df
Merge branch 'main' into qa
KaustubhKumar05 Mar 5, 2024
74cd382
HMS-8358 Add examples for track and stream assets (#2066)
vivekd-100ms Mar 5, 2024
9aab5b7
updated React Native release notes (#2067)
ygit Mar 5, 2024
7819848
Fix stream recording mode changes (#2069)
rtpriya Mar 7, 2024
cb35cb1
Merge branch 'main' into qa
KaustubhKumar05 Mar 7, 2024
aa213fb
docs: update to proper version (#2071)
raviteja83 Mar 7, 2024
bf05052
Merge branch 'main' into qa
KaustubhKumar05 Mar 7, 2024
a6db2e8
Flutter/faq update (#2073)
Decoder07 Mar 8, 2024
c854afe
docs(rn): :sparkles: added expo prebuilt quickstart guide (#2075)
stanwolverine Mar 8, 2024
0bfe4ab
Merge branch 'main' into qa
ygit Mar 8, 2024
70cc315
Update expo-prebuilt.mdx
ygit Mar 8, 2024
b89f593
updated width and height of image
stanwolverine Mar 8, 2024
54f0eb9
Update expo-prebuilt.mdx
ygit Mar 8, 2024
7d62f3d
backmerge: main to qa (#2078)
github-actions[bot] Mar 12, 2024
ae92cee
fix: added new method defination (#2002)
amar-1995 Mar 12, 2024
9bcc7ed
docs(rn): :sparkles: added call interruption handling docs on rn (#2080)
stanwolverine Mar 13, 2024
9dfa206
docs(rn): :sparkles: added docs for quiz leaderboard and quiz (#2060)
stanwolverine Mar 13, 2024
924426d
RN: added `FOREGROUND_SERVICE_MEDIA_PROJECTION` permission in docs (#…
stanwolverine Mar 13, 2024
4d4c820
Merge branch 'main' into qa
ygit Mar 14, 2024
a70cc3f
fix: ignore repetition unless typo
KaustubhKumar05 Mar 14, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ mdx = md


BasedOnStyles = Vale, Google

Vale.Repetition = NO

BlockIgnores = (?s) *(\x60\x60\x60[a-z]*\n[\s\S]*?\x60\x60\x60)

Expand Down
2 changes: 2 additions & 0 deletions docs/javascript/v2/release-notes/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ Released: `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@1
- Roomkit Prebuilt: Missing CSS reset on some components
- Echo in Firefox versions above 116

#### Added:
- Added new method `getNativeTrackById` to fetch native media stream track.

## 2024-01-12
Released: `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`, `@100mslive/[email protected]`
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Interruption Handling
nav: 6.2
---

You're chatting away on your video call and, uh-oh, a phone call comes in. No worries, the 100ms SDK abstracts away handling this situation for you.

When a telephonic voice call comes in and the user accepts the following happens.

- All videos including your own are turned off.
- You are muted.

When the call ends the SDK will restore all videos, taking care not to un-mute you if you had muted yourself before the call came in. Neither will it un-mute all the peers if you had muted them from the app.

No code required, this happens automatically for all calls.

In Android, you will get a `ON_ROOM_UPDATE` event with the update type `HMSRoomUpdate.ROOM_MUTED` when the call starts and `HMSRoomUpdate.ROOM_UNMUTED` when the call ends
and also `ON_TRACK_UPDATE` event for local peer with update type `HMSTrackUpdate.TRACK_MUTED` when call starts and `HMSTrackUpdate.TRACK_UNMUTED` when call ends if the tracks were unmuted earlier.

![interruptionHandle](/docs/v2/flutter-interruption-handle.png)

| **App State** | **Scenario** | **Android** | **iOS** |
| :------------ | :----------------------------------------- | :----------------------------------------- | :----------------------------------------- |
| Foreground | **A Call interrupts Microphone access** | SDK gets the mic access back after call | SDK gets the mic access back after call |
| Background | **A Call interrupts Microphone access** | SDK doesn't get the mic access after call | SDK gets the mic access back after call |
| Foreground | **A Call interrupts Camera access** | SDK gets the camera access back after call | SDK gets the camera access back after call |
| Background | **A Call interrupts Camera access** | SDK gets the camera access back after call | SDK gets the camera access back after call |
| Foreground | **Other app interrupts Microphone access** | SDK gets the mic access back after call | SDK gets the mic access back after call |
| Background | **Other app interrupts Microphone access** | SDK doesn't get the mic access after call | SDK gets the mic access back after call |
| Foreground | **Other app interrupts Camera access** | SDK gets the camera access back after call | SDK gets the camera access back after call |
| Background | **Other app interrupts Camera access** | SDK gets the camera access back after call | SDK gets the camera access back after call |
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Polls
title: Polls & Quizzes
nav: 8.3
---

Expand All @@ -17,17 +17,17 @@ This document provides guidance on how to use the Poll APIs to create a poll, re

## Creating a Poll

### Quick Create
### Quick Start

Here is how to quickly create a poll using poll builder.
Here is how to quickly start a poll

Let's consider an example. We'll create a single-choice poll with the title `Survey` and the question `Do you like TypeScript?` The poll will offer two options: `Yes` and `No`.

```js
await hmsInstance.interactivityCenter.startPoll({
pollId: 'myUniqueID',
title: 'Survey',
type: HMSPollType.poll,
type: HMSPollType.poll, // or `HMSPollType.quiz`
mode: HMSPollUserTrackingMode.customerUserID,
questions: [
{
Expand All @@ -37,10 +37,12 @@ await hmsInstance.interactivityCenter.startPoll({
skippable: false,
options: [
{
text: 'Yes'
text: 'Yes',
// isCorrectAnswer: true // In case of quiz
},
{
text: 'No'
text: 'No',
// isCorrectAnswer: false // In case of quiz
}
]
}
Expand Down Expand Up @@ -86,17 +88,62 @@ const selectedOptionIndex = 1;

await hmsInstance.interactivityCenter.add({
pollId,
pollQuestionIndex: pollQuestion.index,
pollQuestionIndex: pollQuestion.index, // index of the question
responses: {
options: [selectedOptionIndex]
options: [selectedOptionIndex] // array of selected option indices, single item if it's a single-choice question and one or more if it's a multiple-choice question
}
});
```

Once you have submitted your responses, other peers in the room will get `POLL_VOTES_UPDATED` notification. You can check updated vote counts for each option of poll questions.

## Stopping a Poll

Use `hmsInstance.interactivityCenter.stop(pollId: string)` method when you want to stop the Poll and prevent further responses recorded.

```js
await hmsInstance.interactivityCenter.stop(pollId);
```

## Fetching the Quiz Leaderboard

Once the quiz has ended, the leaderboard can be fetched which has the quiz summary and peer level statistics sorted by score using the asynchronous `fetchLeaderboard` function added to the interactivityCenter.

```js
const response = await hmsInstance.interactivityCenter.fetchLeaderboard(
quizId, // `pollId` of the poll/quiz
5, // The number of peer entries that should be fetched at a time
1, // The position offset after which the peer level entries should be fetched
false, // Whether to include the current peer in the fetched leaderboard entries
);
```
The props accepted are:
- `quizId` :HMSPoll - `pollId` of the poll/quiz
- `count` :number - The number of peer entries that should be fetched at a time
- `offset` :number - The position offset after which the peer level entries should be fetched, Note that "Indexing starts from 1"
- `includeCurrentPeer`: boolean - Whether to include the current peer in the fetched leaderboard entries

The response contains:
- An array of entries of type `HMSPollLeaderboardEntry`,
- A boolean `hasNext` which indicates if there are more entries to be fetched, and
- An object of type `HMSPollLeaderboardSummary` containing details like the average score, average time taken to answer a question, number of users with all correct answers and more.

```ts
{
entries: [...],
summary: {
totalUsers: number,
votedUsers: number,
avgScore: number,
avgTime: number,
correctUsers: number,
};
hasNext: false
}
```

## Viewing Poll Results Summary

After poll has ended you can use `poll.result` to get statistics like how many peers responded and how many total peers were in the room at the time of poll.

> Have a look at the [API reference of polls](https://www.100ms.live/docs/api-reference/react-native/v2/interfaces/HMSPoll.html) to understand the interface better
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,12 @@ Follow below steps to start audio share on android devices -

#### Native file change

Add `FOREGROUND_SERVICE` permission and `HMSAudioshareActivity` activity in the `android/app/src/main/AndroidManifest.xml` file -
Add `FOREGROUND_SERVICE`, `FOREGROUND_SERVICE_MEDIA_PROJECTION` permission and `HMSAudioshareActivity` activity in the `android/app/src/main/AndroidManifest.xml` file -

```xml{2, 8-10}
```xml{2-3, 9-11}
<manifest {...} >
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
...

<application {...} >
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Please note that for a peer to share their screen, their role must have screensh

## Android Setup

<div className="steps-container">

### Step 1 - Add Screenshare Activity in your AndroidManifest file

Add `HmsScreenshareActivity` to manifest located at `android/app/src/main/AndroidManifest.xml` as follows -

```xml
Expand All @@ -29,6 +33,19 @@ Add `HmsScreenshareActivity` to manifest located at `android/app/src/main/Androi
</application>
```

### Step 2 - Add Permission in in your AndroidManifest file

If you are targeting Android 14 and above, You also need to add `FOREGROUND_SERVICE_MEDIA_PROJECTION` permission in manifest located at `android/app/src/main/AndroidManifest.xml` as follows -

```xml{2}
<manifest {...}>
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
{...}
</manifest>
```

</div>

## iOS Setup

You need to create an iOS broadcast upload extension. It uses Apple's ReplayKit framework to record the device screen and delivers frame samples to your broadcast extension. You can share not only your own app but also the entire device sceeen including other apps on the device.
Expand Down
2 changes: 2 additions & 0 deletions docs/react-native/v2/quickstart/prebuilt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ nav: 2.1

This guide will walk you through simple instructions to create a Video Conferencing app using the 100ms Prebuilt and test it using an Emulator or your Mobile Phone. Ensure that you are using the latest versions of the packages.

> Note: If you are using Expo, refer to the [Expo & Prebuilt Quickstart guide](./expo-prebuilt).

| Package | Version |
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| @100mslive/react-native-room-kit | [![npm](https://img.shields.io/npm/v/@100mslive/react-native-room-kit)](https://www.npmjs.com/package/@100mslive/react-native-room-kit) |
Expand Down
Loading