Skip to content

Commit

Permalink
Merge pull request #2415 from 100mslive/qa
Browse files Browse the repository at this point in the history
Release PR
  • Loading branch information
KaustubhKumar05 authored Oct 15, 2024
2 parents 4edd9b8 + 0dafc03 commit 4bed7bb
Show file tree
Hide file tree
Showing 31 changed files with 820 additions and 632 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
14 changes: 1 addition & 13 deletions components/Footer.tsx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import React from 'react';
import {
ChatIcon,
DiscordIcon,
FacebookIcon,
LinkedInIcon,
Svg100MsLogo,
Expand Down Expand Up @@ -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">
Expand Down
22 changes: 1 addition & 21 deletions components/Header.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down Expand Up @@ -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"
Expand Down
2 changes: 0 additions & 2 deletions docs/android/v2/quickstart/prebuilt-android.mdx
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
2 changes: 1 addition & 1 deletion docs/flutter/v2/how-to-guides/debugging/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -222,4 +222,4 @@ To ensure that the message sent by the local peer is included in your messages l

### I want to suggest a new feature.

Awesome, we're always looking out for new ideas and features. Please reach out to us over [discord](https://100ms.live/discord)
Awesome, we're always looking out for new ideas and features.
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,4 @@ class Meeting implements HMSUpdateListener, HMSActionResultListener{
}
```

</div>

There are many use cases which can be implemented using peer metadata. Have any questions regarding the use cases please reach out to us [here](https://100ms.live/discord)
</div>
2 changes: 0 additions & 2 deletions docs/flutter/v2/quickstart/flutterflow-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,6 @@ Flutterflow uses `go_router` whereas `hms_room_kit` uses `MaterialPageRoute` for

That's it. You can now use the amazing Prebuilt UI with speed of Flutterflow in your application.

If you face any issues or have any questions, please reach out to us on [Discord](https://discord.gg/jD94Fp74Ea)

## Next steps

We have multiple example apps to get you started with 100ms Flutter SDK.
Expand Down
3 changes: 0 additions & 3 deletions docs/flutter/v2/quickstart/prebuilt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,3 @@ class HMSPrebuiltOptions {
- iOSScreenshareConfig: `HMSIOSScreenshareConfig?` - If you want to enable screenshare in your iOS app, you need to pass the `iOSScreenshareConfig` parameter.
To know more about how to set iOSScreenshareConfig check the docs [here](https://www.100ms.live/docs/flutter/v2/how-to-guides/set-up-video-conferencing/screen-share#ios-setup).
- enableNoiseCancellation: `bool` - To enable noise cancellation in prebuilt. Default value is `true`.

Have questions or need help?
Feel free to join us on [Discord](https://discord.gg/jD94Fp74Ea)
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ let isnoiseCancellationEnabled = noiseCancellationPlugin.isEnabled()

## How to check if noise cancellation is enabled in the room

To make noise cancellation work your room needs to have noise cancellation feature enabled. You can check if noise cancellation is enabled using isNoiseCancellationAvailable property on noiseCancellationPlugin. To enable noise canellation in your rooms, reach out to support@100ms.live or 100ms discord.
To make noise cancellation work your room needs to have noise cancellation feature enabled. You can check if noise cancellation is enabled using isNoiseCancellationAvailable property on noiseCancellationPlugin. To enable noise canellation in your rooms, reach out to support@100ms.live.

```swift
let isNoiseCancellationAvailableInTheRoom = noiseCancellationPlugin.isNoiseCancellationAvailable
Expand Down
5 changes: 5 additions & 0 deletions docs/ios/v2/release-notes/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ nav: 6.1
description: Release Notes for 100ms iOS SDK
---

## 1.16.5 - 2024-10-15
### Fixed
- No audio sent when changing role from non-publishing to publishing


## 1.16.4 - 2024-10-14
### Added
- Audio session errors reporting with error code 3015
Expand Down
4 changes: 2 additions & 2 deletions docs/javascript/v2/how-to-guides/debugging/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ should treat it similar to the track turning off for purpose of displaying avata

#### Do you have UI components?

Not yet, but it's work in progress for react. Do let us know on discord if you want to sign up for beta and we'll hit you up soon.
Not yet, but it's work in progress for react. Do let us know on support@100ms.live if you want to sign up for beta and we'll hit you up soon.

#### Can I use the SDK with NextJS, Angular, Svelte, VueJS etc.?

Expand All @@ -111,7 +111,7 @@ guide is with vanilla JS and doesn't assume any framework.

#### I want to suggest a new feature.

Awesome, we're always on the lookout for new ideas and feature. Please reach out to us over [discord](https://100ms.live/discord).
Awesome, we're always on the lookout for new ideas and feature. Please reach out to us at support@100ms.live.

#### I'm facing an issue, how do I reach out?

Expand Down
3 changes: 1 addition & 2 deletions docs/javascript/v2/how-to-guides/debugging/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,7 @@ Do check the detailed page for listening to and handling errors [here](/javascri

## Reaching Out

If nothing else works, feel free to create an issue [here](https://github.com/100mslive/100ms-web/issues) or reach out to us
on [discord](https://100ms.live/discord), there is a channel there for web-sdk-discussion.
If nothing else works, feel free to create an issue [here](https://github.com/100mslive/100ms-web/issues).
If you're reporting a bug, we would appreciate as many details possible. We might further ask you for the following information to debug the issues better -

### Steps to reproduce
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ nav: 1.49

<Note type="warning">
This feature is still in Beta. To know more or report any issues, feel free to reach out to us
over <a href={'https://discord.com/invite/kGdmszyzq2'}>Discord</a>.
over support@100ms.live.
</Note>

Custom audio plugins allow you to hook into 100ms' video lifecycle and add your own audio processing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ nav: 1.48

<Note type="warning">
This feature is still in Beta. To know more or report any issues, feel free to reach out to us
over <a href={'https://discord.com/invite/kGdmszyzq2'}>Discord</a>.
over support@100ms.live.
</Note>

Custom video plugins allow you to hook into 100ms' video lifecycle and add your own video processing
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: Virtual Background with Effects SDK
nav: 1.45
---

<Note type="warning">
<Note type="warning">
This feature is still in Beta. To know more or report any issues, feel free to reach out to us
over <a href={'https://discord.com/invite/kGdmszyzq2'}>Discord</a>.
over support@100ms.live.
</Note>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ nav: 1.38

<Note type="warning">
This feature is still in Beta. To know more or report any issues, feel free to reach out to us
over <a href={'https://discord.com/invite/kGdmszyzq2'}>Discord</a>.
over support@100ms.live.
</Note>

`@100ms-live/hls-stats` is a simple library that provides easy to use APIs for acquiring stats
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ nav: 1.37

<Note type="warning">
This feature is still in Beta. To know more or report any issues, feel free to reach out to us
over <a href={'https://discord.com/invite/kGdmszyzq2'}>Discord</a>.
over support@100ms.live.
</Note>

Sometimes you need a way to capture certain metrics related to a call. This may be helpful if you want to tailor the experience to your users or debug issues. Typical metrics of interest are audio/video bitrate, round trip time, total consumed bandwidth and packet loss. <APILink type="class" name="HMSReactiveStore#get-stats">`getStats`</APILink> has got your back.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ start_date and end_date will be in UTC timezone.

### App side implementation

> Note: We're working on making this simpler - if you'd like to try out the feature in beta, please reach out to us on Discord or at hello@100ms.live
> Note: We're working on making this simpler - if you'd like to try out the feature in beta, please reach out to us at hello@100ms.live
Below is an app side sample integration using hls.js.

Expand Down
2 changes: 1 addition & 1 deletion docs/javascript/v2/quickstart/mental-model.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -185,4 +185,4 @@ As we see, using this decoupled state-driven approach, we can write concise and

## What Next?

Equipped with the above mental model, you’ll find it quite easy to navigate through our docs. Whether you’re skimming to get a sense of what is possible or trying to implement something in your own code, it all comes down to ***actions*** and ***states***. The best place to start would be with one of the Quickstarts linked in the sidebar. We also welcome you to join our [Discord](https://100ms.live/discord) - feel free to reach out to us there with any questions or feedback.
Equipped with the above mental model, you’ll find it quite easy to navigate through our docs. Whether you’re skimming to get a sense of what is possible or trying to implement something in your own code, it all comes down to ***actions*** and ***states***. The best place to start would be with one of the Quickstarts linked in the sidebar.
2 changes: 1 addition & 1 deletion docs/javascript/v2/quickstart/prebuilt-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ nav: 1.01
This guide will walk you through the steps to create a video conferencing app using the Prebuilt component of the Roomkit package.
Prebuilt is currently available for React applications, so basic familiarity with [React](https://reactjs.org/) is required to follow this guide.

> 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).
> If you get stuck at any point or need help in understanding a concept, you can put your query in at support@100ms.live.
## Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion docs/javascript/v2/quickstart/react-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ TL;DR - Try out this complete example in [CodeSandbox](https://codesandbox.io/s/

<Codesandbox id="github/100mslive/100ms-examples/tree/main/web/react-quickstart" />

> 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).
> If you get stuck at any point or need help in understanding a concept, you can put your query in at support@100ms.live.
### Prerequisites

Expand Down
3 changes: 1 addition & 2 deletions docs/prebuilt/v2/prebuilt/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,7 @@ Refer the sample code snippet to embed the Prebuilt link as an iframe.
Native - This is the highest-level UI component of a room, covering all screens and
functionality - This component is shipped through `RoomKit` packages - The `RoomKit` package
will contain more (lower-level) UI components - If you need a specific UI component, share
your feedback on [our Prebuilt Discord
channel](https://discord.com/channels/843749923060711464/1145960444230647808)
your feedback on our email support@100ms.live
</Callout>
</FlexContainer>

Expand Down
2 changes: 1 addition & 1 deletion docs/prebuilt/v2/prebuilt/virtual-background.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Adding a virtual background to your calls can help present a clean and organized

<Note title ="Platform Support">

Virtual backgrounds are currently supported only on the Prebuilt web links and component. Reach out on [Prebuilt Discord channel](https://discord.com/channels/843749923060711464/1145960444230647808) to explore adding support for Android, iOS, React Native, and Flutter.
Virtual backgrounds are currently supported only on the Prebuilt web links and component. Reach out on support@100ms.live to explore adding support for Android, iOS, React Native, and Flutter.

</Note>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ hmsInstance.join(hmsConfig)

## Check if Noise Cancellation is Supported in the Room

By default, Noise Cancellation is not enabled in a Room. To enable Noise Cancellation in your rooms, reach out to **support@100ms.live** or connect with us on [100ms Discord](https://discord.com/invite/kGdmszyzq2).
By default, Noise Cancellation is not enabled in a Room. To enable Noise Cancellation in your rooms, reach out to **support@100ms.live**.

```js
const isAvailable = await noiseCancellationPlugin?.isNoiseCancellationAvailable();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,4 +136,4 @@ hmsInstance.addEventListener(HMSUpdateListenerActions.ON_PEER_UPDATE, onPeerList

We can use peers' `metadata` property to implement polls similar to what we did in above implementation.

There are many more use cases which can be implemented using peer metadata. Have any questions regarding the use cases please reach out to us [here](https://100ms.live/discord)
There are many more use cases which can be implemented using peer metadata. Have any questions regarding the use cases please reach out to us support@100ms.live
2 changes: 1 addition & 1 deletion docs/react-native/v2/quickstart/expo-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1220,7 +1220,7 @@ export const updateNode = (data) => {
//#endregion Utility
```
We encourage you to explore the relevant documentation and guides for further details. If you have any questions or need assistance, feel free to ask in the 100ms [![Discord](https://img.shields.io/discord/843749923060711464?label=Join%20on%20Discord)](https://100ms.live/discord) community!
We encourage you to explore the relevant documentation and guides for further details. If you have any questions or need assistance, feel free to ask in the support email support@100ms.live
### Test run your app
Expand Down
Loading

0 comments on commit 4bed7bb

Please sign in to comment.