Merge branch 'qa' into release_notes_android

100mslive · Nov 12, 2024 · f1c5fec · f1c5fec
2 parents 9cdf15f + dd469a9
commit f1c5fec
Show file tree

Hide file tree

Showing 248 changed files with 1,421 additions and 1,007 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -17,11 +17,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+      - run: |
+          venv="$HOME/.local/share/venv"
+          python3 -m venv "$venv"
+          echo "$venv/bin" >> $GITHUB_PATH
       - uses: errata-ai/vale-action@reviewdog
         env:
           # Required, set by GitHub actions automatically:
           # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          GITHUB_TOKEN: ${{secrets.DOCKER_GIT_TOKEN}}
         with:
           # Reporter of reviewdog command [github-pr-check,github-pr-review,github-check].
           reporter: github-pr-check # optional, default is github-pr-check

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,6 +1,10 @@
 # Contributing
 
-Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [100ms Docs](https://docs.100ms.live/) If you don't know where to start contributing, ask us on our [Discord channel](http://100ms.live/discord).
+<!-- vale off -->
+
+Thank you for investing your time in contributing to our project & Any contribution you make will be reflected on [100ms Docs](https://docs.100ms.live/)
+
+<!-- vale on-->
 
 In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
 

diff --git a/README.md b/README.md
@@ -3,8 +3,6 @@
     <img src="public/logo.svg" alt="Logo" width="200" >
 </p>
 
-[![Discord](https://img.shields.io/discord/843749923060711464?label=Join%20on%20Discord)](https://100ms.live/discord)
-
 <br />
 
 > If you're here to contribute do check out our [Contributing Guidelines](CONTRIBUTING.md) & our [Code of Conduct](CODE_OF_CONDUCT.md)
@@ -19,7 +17,7 @@ To run locally
 -   `yarn` or `npm install`
 -   `yarn dev` or `npm run dev`
 
-All docs are written in `MDX` this helps use to use React Components along with the flavor of Markdown Syntax.
+All docs are written in `MDX`. This allows usage of React components along with the flavor of Markdown Syntax.
 
 All docs reside in the [/docs](https://github.com/100mslive/100ms-docs/tree/main/docs) folder.
 
@@ -52,7 +50,7 @@ nav: 14 // Ranking of Item in the Sidebar
 
 By default Nav is given the value of `Infinity` it's important to add `nav` value to order the Sidebar.
 
-But suppose you wanna update the order of 1 doc , then you don't need to change nav value of all them simply make the nav value in between the preceding and next doc it can be in decimal value too.
+But suppose you want to update the order of a doc , then you don't need to change the nav values for all of them. Simply make the nav value in between the preceding and next doc. It can be a decimal value too.
 
 ### 2. To a new Docs (for v3 and soo on)
 

diff --git a/components/Feedback.tsx b/components/Feedback.tsx
@@ -59,7 +59,7 @@ const Feedback = () => {
                                     rating: emoji.score,
                                     timeStamp: new Date().toLocaleString(),
                                     customer_id: userDetails?.customer_id,
-                                    user_id: userDetails?.user_id,
+                                    internal_user_id: userDetails?.user_id,
                                     email: userDetails?.email
                                 });
                                 setFirstSelection(emoji.score);
@@ -130,7 +130,7 @@ const Feedback = () => {
                                     path: window.location.pathname,
                                     timeStamp: new Date().toLocaleString(),
                                     customer_id: userDetails?.customer_id,
-                                    user_id: userDetails?.user_id,
+                                    internal_user_id: userDetails?.user_id,
                                     email: userDetails?.email
                                 });
                                 setSubmitSuccessful(true);

diff --git a/components/Footer.tsx b/components/Footer.tsx
@@ -1,7 +1,6 @@
 import React from 'react';
 import {
     ChatIcon,
-    DiscordIcon,
     FacebookIcon,
     LinkedInIcon,
     Svg100MsLogo,
@@ -63,18 +62,7 @@ const Footer: React.FC<Props> = ({ css = {} }) => (
                                     />
                                 </Box>
                             </a>
-                            <a href="https://discord.com/invite/kGdmszyzq2">
-                                <Box css={{ color: '$textMedEmp' }}>
-                                    <DiscordIcon
-                                        style={{
-                                            width: '27px',
-                                            height: '27px',
-                                            padding: '4.5px',
-                                            color: 'inherit'
-                                        }}
-                                    />
-                                </Box>
-                            </a>
+
                         </Box>
                     </Box>
                     <Box className="details">

diff --git a/components/Header.tsx b/components/Header.tsx
@@ -3,13 +3,12 @@ import { useRouter } from 'next/router';
 import {
     CrossIcon,
     HamburgerMenuIcon,
-    DiscordIcon,
     GithubIcon,
     ExternalLinkIcon,
     SearchIcon
 } from '@100mslive/react-icons';
 import { Flex, Text, useTheme } from '@100mslive/react-ui';
-import { WebsiteLink, DashboardLink, GitHubLink, DiscordLink, ContactLink } from '@/lib/utils';
+import { WebsiteLink, DashboardLink, GitHubLink, ContactLink } from '@/lib/utils';
 import { references } from 'api-references';
 import { exposedPlatformNames } from 'common';
 import SearchModal from './SearchModal';
@@ -208,25 +207,6 @@ const Header: React.FC<Props> = ({
                         Dashboard
                     </HeaderLink>
 
-                    <UtmLinkWrapper href={DiscordLink}>
-                        <a
-                            target="_blank"
-                            rel="noreferrer"
-                            onClick={() =>
-                                AppAnalytics.track('link.clicked', {
-                                    btnId: 'discord.clicked',
-                                    currentPage: window.location.href
-                                })
-                            }>
-                            <Text css={linkCSS}>
-                                <DiscordIcon
-                                    height={18}
-                                    width={18}
-                                    style={{ marginRight: '-14px' }}
-                                />
-                            </Text>
-                        </a>
-                    </UtmLinkWrapper>
                     <UtmLinkWrapper href={GitHubLink}>
                         <a
                             target="_blank"

diff --git a/components/SegmentAnalytics.tsx b/components/SegmentAnalytics.tsx
@@ -1,5 +1,6 @@
 import React from 'react';
 import { AppAnalytics } from '../lib/publishEvents';
+
 const SegmentAnalytics = ({ title, options }) => {
     React.useEffect(() => {
         if (typeof window !== 'undefined') {
@@ -12,24 +13,11 @@ const SegmentAnalytics = ({ title, options }) => {
                 }, {});
             // @ts-ignore
             const url = new URL(window.location.href);
-            AppAnalytics.page(title, {
-                ...params,
-                ...options,
-                title,
-                referrer: document.referrer,
-                path: window.location.hostname,
-                pathname: window.location.pathname,
-                href: window.location.href,
-                utm_source: url.searchParams.get('utm_source'),
-                utm_medium: url.searchParams.get('utm_medium'),
-                utm_campaign: url.searchParams.get('utm_campaign'),
-                utm_keyword: url.searchParams.get('utm_keyword'),
-                utm_term: url.searchParams.get('utm_term')
-            });
+            AppAnalytics.page();
             AppAnalytics.track('page.viewed', {
                 ...params,
                 ...options,
-                title: document.title,
+                title: document.title || title,
                 referrer: document.referrer,
                 path: window.location.hostname,
                 pathname: window.location.pathname,

diff --git a/docs/android/v2/quickstart/prebuilt-android.mdx b/docs/android/v2/quickstart/prebuilt-android.mdx
@@ -7,8 +7,6 @@ nav: 5.3
 
 This guide will walk you through the steps to create a video conferencing app using Prebuilt component of the `room-kit` package.
 
-> If you get stuck at any point or need help in understanding a concept, you can put your query in our [Discord Channel](https://100ms.live/discord).
-
 
 ## Prerequisites
 

diff --git a/docs/api-reference/javascript/v2/classes/EventBus.md b/docs/api-reference/javascript/v2/classes/EventBus.md
@@ -71,6 +71,12 @@ nav: '3.2'
 
 ---
 
+### localAudioUnmutedNatively
+
+• `Readonly` **localAudioUnmutedNatively**: `HMSInternalEvent`<`unknown`\>
+
+---
+
 ### localRoleUpdate
 
 • `Readonly` **localRoleUpdate**: `HMSInternalEvent`<{ `newRole`: [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole) ; `oldRole`: [`HMSRole`](/api-reference/javascript/v2/interfaces/HMSRole) }\>

diff --git a/docs/api-reference/javascript/v2/enums/HMSAudioDeviceCategory.md b/docs/api-reference/javascript/v2/enums/HMSAudioDeviceCategory.md
@@ -0,0 +1,28 @@
+---
+title: HMSAudioDeviceCategory
+nav: '2.6'
+---
+
+## Enumeration Members
+
+### BLUETOOTH
+
+• **BLUETOOTH** = `"BLUETOOTH"`
+
+---
+
+### EARPIECE
+
+• **EARPIECE** = `"EARPIECE"`
+
+---
+
+### SPEAKERPHONE
+
+• **SPEAKERPHONE** = `"SPEAKERPHONE"`
+
+---
+
+### WIRED
+
+• **WIRED** = `"WIRED"`
diff --git a/docs/api-reference/javascript/v2/enums/HMSAudioMode.md b/docs/api-reference/javascript/v2/enums/HMSAudioMode.md
@@ -1,6 +1,6 @@
 ---
 title: HMSAudioMode
-nav: '2.6'
+nav: '2.7'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSAudioPluginType.md b/docs/api-reference/javascript/v2/enums/HMSAudioPluginType.md
@@ -1,6 +1,6 @@
 ---
 title: HMSAudioPluginType
-nav: '2.7'
+nav: '2.8'
 ---
 
 Specifies the type of the plugin a transforming plugin will get an output audio node to give the resulting

diff --git a/docs/api-reference/javascript/v2/enums/HMSLogLevel.md b/docs/api-reference/javascript/v2/enums/HMSLogLevel.md
@@ -1,6 +1,6 @@
 ---
 title: HMSLogLevel
-nav: '2.8'
+nav: '2.9'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSNotificationSeverity.md b/docs/api-reference/javascript/v2/enums/HMSNotificationSeverity.md
@@ -1,6 +1,6 @@
 ---
 title: HMSNotificationSeverity
-nav: '2.9'
+nav: '2.10'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSNotificationTypes.md b/docs/api-reference/javascript/v2/enums/HMSNotificationTypes.md
@@ -1,6 +1,6 @@
 ---
 title: HMSNotificationTypes
-nav: '2.10'
+nav: '2.11'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSPeerType.md b/docs/api-reference/javascript/v2/enums/HMSPeerType.md
@@ -1,6 +1,6 @@
 ---
 title: HMSPeerType
-nav: '2.11'
+nav: '2.12'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSPlaylistType.md b/docs/api-reference/javascript/v2/enums/HMSPlaylistType.md
@@ -1,6 +1,6 @@
 ---
 title: HMSPlaylistType
-nav: '2.12'
+nav: '2.13'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSPluginUnsupportedTypes.md b/docs/api-reference/javascript/v2/enums/HMSPluginUnsupportedTypes.md
@@ -1,6 +1,6 @@
 ---
 title: HMSPluginUnsupportedTypes
-nav: '2.13'
+nav: '2.14'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSPollQuestionType.md b/docs/api-reference/javascript/v2/enums/HMSPollQuestionType.md
@@ -1,6 +1,6 @@
 ---
 title: HMSPollQuestionType
-nav: '2.14'
+nav: '2.15'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSPollStates.md b/docs/api-reference/javascript/v2/enums/HMSPollStates.md
@@ -1,6 +1,6 @@
 ---
 title: HMSPollStates
-nav: '2.15'
+nav: '2.16'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSRecordingState.md b/docs/api-reference/javascript/v2/enums/HMSRecordingState.md
@@ -1,6 +1,6 @@
 ---
 title: HMSRecordingState
-nav: '2.16'
+nav: '2.17'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSRoomState.md b/docs/api-reference/javascript/v2/enums/HMSRoomState.md
@@ -1,6 +1,6 @@
 ---
 title: HMSRoomState
-nav: '2.17'
+nav: '2.18'
 ---
 
 Check out internal-docs/RoomStateFlow.tldr for flow of room state

diff --git a/docs/api-reference/javascript/v2/enums/HMSSimulcastLayer.md b/docs/api-reference/javascript/v2/enums/HMSSimulcastLayer.md
@@ -1,6 +1,6 @@
 ---
 title: HMSSimulcastLayer
-nav: '2.18'
+nav: '2.19'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSTrackExceptionTrackType.md b/docs/api-reference/javascript/v2/enums/HMSTrackExceptionTrackType.md
@@ -0,0 +1,28 @@
+---
+title: HMSTrackExceptionTrackType
+nav: '2.20'
+---
+
+## Enumeration Members
+
+### AUDIO
+
+• **AUDIO** = `"audio"`
+
+---
+
+### AUDIO_VIDEO
+
+• **AUDIO_VIDEO** = `"audio, video"`
+
+---
+
+### SCREEN
+
+• **SCREEN** = `"screen"`
+
+---
+
+### VIDEO
+
+• **VIDEO** = `"video"`
diff --git a/docs/api-reference/javascript/v2/enums/HMSTranscriptionMode.md b/docs/api-reference/javascript/v2/enums/HMSTranscriptionMode.md
@@ -1,6 +1,6 @@
 ---
 title: HMSTranscriptionMode
-nav: '2.19'
+nav: '2.21'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSTranscriptionState.md b/docs/api-reference/javascript/v2/enums/HMSTranscriptionState.md
@@ -1,6 +1,6 @@
 ---
 title: HMSTranscriptionState
-nav: '2.20'
+nav: '2.22'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSVideoPluginCanvasContextType.md b/docs/api-reference/javascript/v2/enums/HMSVideoPluginCanvasContextType.md
@@ -1,6 +1,6 @@
 ---
 title: HMSVideoPluginCanvasContextType
-nav: '2.21'
+nav: '2.23'
 ---
 
 ## Enumeration Members

diff --git a/docs/api-reference/javascript/v2/enums/HMSVideoPluginType.md b/docs/api-reference/javascript/v2/enums/HMSVideoPluginType.md
@@ -1,6 +1,6 @@
 ---
 title: HMSVideoPluginType
-nav: '2.22'
+nav: '2.24'
 ---
 
 Specifies the type of the plugin a transforming plugin will get an output canvas to give the resulting
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,8 +7,6 @@ nav: 5.3

		This guide will walk you through the steps to create a video conferencing app using Prebuilt component of the `room-kit` package.

		> If you get stuck at any point or need help in understanding a concept, you can put your query in our [Discord Channel](https://100ms.live/discord).


		## Prerequisites

Expand Down