Skip to content

Commit

Permalink
Merge branch 'main' into update-min-ff-version
Browse files Browse the repository at this point in the history
  • Loading branch information
ltrung authored Dec 27, 2021
2 parents c6eb373 + 6b46305 commit 4b21267
Show file tree
Hide file tree
Showing 16 changed files with 100 additions and 73 deletions.
11 changes: 10 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,16 @@ reported the issue. When possible use an existing template and provide all the i

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

1. You are working against the latest source on the *master* branch.
1. You are working against the latest source on the *main* branch.

Note that we recently renamed our branch from *master* to *main*. If you have checked out our repo before, please run the following commands:

```
git branch -m master main
git fetch origin
git branch -u origin/main main
git remote set-head origin -a
```
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
3. You open an issue to discuss any significant work.

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ The following developer guides cover the Amazon Chime SDK more broadly.
## Examples

- [Amazon Chime SDK Samples](https://github.com/aws-samples/amazon-chime-sdk) — Amazon Chime SDK Samples repository
- [Meeting Demo](https://github.com/aws/amazon-chime-sdk-js/tree/master/demos/browser) — A browser
- [Meeting Demo](https://github.com/aws/amazon-chime-sdk-js/tree/main/demos/browser) — A browser
meeting application with a local server
- [Serverless Meeting Demo](https://github.com/aws/amazon-chime-sdk-js/tree/master/demos/serverless) — A self-contained serverless meeting application
- [Serverless Meeting Demo](https://github.com/aws/amazon-chime-sdk-js/tree/main/demos/serverless) — A self-contained serverless meeting application
- [Single JS](https://github.com/aws-samples/amazon-chime-sdk/tree/main/utils/singlejs) — A script to bundle the SDK into a single `.js` file
- [Recording Demo](https://aws.amazon.com/blogs/business-productivity/how-to-enable-client-side-recording-using-the-amazon-chime-sdk/) — Recording the meeting's audio, video and screen share in high definition
- [Virtual Classroom](https://aws.amazon.com/blogs/business-productivity/building-a-virtual-classroom-application-using-the-amazon-chime-sdk/) — An online classroom built with Electron and React
Expand Down Expand Up @@ -1253,7 +1253,7 @@ The use of Amazon Voice Focus and background blur via this SDK involves the down

The use of Amazon Voice Focus and background blur runtime code is subject to additional notices. See [this Amazon Voice Focus NOTICES file](https://static.sdkassets.chime.aws/workers/NOTICES.txt) and [background blur NOTICES file](https://static.sdkassets.chime.aws/bgblur/workers/NOTICES.txt) for details. You agree to make these additional notices available to all end users who use Amazon Voice Focus and background blur runtime code via this SDK.

The browser demo applications in the [demos directory](https://github.com/aws/amazon-chime-sdk-js/tree/master/demos) use [TensorFlow.js](https://github.com/tensorflow/tfjs) and pre-trained [TensorFlow.js models](https://github.com/tensorflow/tfjs-models) for image segmentation. Use of these third party models involves downloading and execution of code at runtime from [jsDelivr](https://www.jsdelivr.com/) by end user browsers. For the jsDelivr Acceptable Use Policy, please visit this [link](https://www.jsdelivr.com/terms/acceptable-use-policy-jsdelivr-net).
The browser demo applications in the [demos directory](https://github.com/aws/amazon-chime-sdk-js/tree/main/demos) use[TensorFlow.js](https://github.com/tensorflow/tfjs) and pre-trained [TensorFlow.js models](https://github.com/tensorflow/tfjs-models) for image segmentation. Use of these third party models involves downloading and execution of code at runtime from [jsDelivr](https://www.jsdelivr.com/) by end user browsers. For the jsDelivr Acceptable Use Policy, please visit this [link](https://www.jsdelivr.com/terms/acceptable-use-policy-jsdelivr-net).

The use of TensorFlow runtime code referenced above may be subject to additional license requirements. See the licenses page for TensorFlow.js [here](https://github.com/tensorflow/tfjs/blob/master/LICENSE) and TensorFlow.js models [here](https://github.com/tensorflow/tfjs-models/blob/master/LICENSE) for details.

Expand Down
2 changes: 1 addition & 1 deletion demos/serverless/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Serverless Demo

This demo shows how to deploy [Chime SDK Browser Demo](https://github.com/aws/amazon-chime-sdk-js/tree/master/demos/browser) as self-contained serverless applications.
This demo shows how to deploy [Chime SDK Browser Demo](https://github.com/aws/amazon-chime-sdk-js/tree/main/demos/browser) as self-contained serverless applications.

> *Note: Deploying the Amazon Chime SDK demo applications contained in this repository will cause your AWS Account to be billed for services, including the Amazon Chime SDK, used by the application.*
Expand Down
6 changes: 3 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -189,9 +189,9 @@ <h2>Examples</h2>
</a>
<ul>
<li><a href="https://github.com/aws-samples/amazon-chime-sdk">Amazon Chime SDK Samples</a> — Amazon Chime SDK Samples repository</li>
<li><a href="https://github.com/aws/amazon-chime-sdk-js/tree/master/demos/browser">Meeting Demo</a> — A browser
<li><a href="https://github.com/aws/amazon-chime-sdk-js/tree/main/demos/browser">Meeting Demo</a> — A browser
meeting application with a local server</li>
<li><a href="https://github.com/aws/amazon-chime-sdk-js/tree/master/demos/serverless">Serverless Meeting Demo</a> — A self-contained serverless meeting application</li>
<li><a href="https://github.com/aws/amazon-chime-sdk-js/tree/main/demos/serverless">Serverless Meeting Demo</a> — A self-contained serverless meeting application</li>
<li><a href="https://github.com/aws-samples/amazon-chime-sdk/tree/main/utils/singlejs">Single JS</a> — A script to bundle the SDK into a single <code>.js</code> file</li>
<li><a href="https://aws.amazon.com/blogs/business-productivity/how-to-enable-client-side-recording-using-the-amazon-chime-sdk/">Recording Demo</a> — Recording the meeting&#39;s audio, video and screen share in high definition</li>
<li><a href="https://aws.amazon.com/blogs/business-productivity/building-a-virtual-classroom-application-using-the-amazon-chime-sdk/">Virtual Classroom</a> — An online classroom built with Electron and React</li>
Expand Down Expand Up @@ -1208,7 +1208,7 @@ <h2>Notice</h2>
</a>
<p>The use of Amazon Voice Focus and background blur via this SDK involves the downloading and execution of code at runtime by end users.</p>
<p>The use of Amazon Voice Focus and background blur runtime code is subject to additional notices. See <a href="https://static.sdkassets.chime.aws/workers/NOTICES.txt">this Amazon Voice Focus NOTICES file</a> and <a href="https://static.sdkassets.chime.aws/bgblur/workers/NOTICES.txt">background blur NOTICES file</a> for details. You agree to make these additional notices available to all end users who use Amazon Voice Focus and background blur runtime code via this SDK.</p>
<p>The browser demo applications in the <a href="https://github.com/aws/amazon-chime-sdk-js/tree/master/demos">demos directory</a> use <a href="https://github.com/tensorflow/tfjs">TensorFlow.js</a> and pre-trained <a href="https://github.com/tensorflow/tfjs-models">TensorFlow.js models</a> for image segmentation. Use of these third party models involves downloading and execution of code at runtime from <a href="https://www.jsdelivr.com/">jsDelivr</a> by end user browsers. For the jsDelivr Acceptable Use Policy, please visit this <a href="https://www.jsdelivr.com/terms/acceptable-use-policy-jsdelivr-net">link</a>.</p>
<p>The browser demo applications in the <a href="https://github.com/aws/amazon-chime-sdk-js/tree/main/demos">demos directory</a> use<a href="https://github.com/tensorflow/tfjs">TensorFlow.js</a> and pre-trained <a href="https://github.com/tensorflow/tfjs-models">TensorFlow.js models</a> for image segmentation. Use of these third party models involves downloading and execution of code at runtime from <a href="https://www.jsdelivr.com/">jsDelivr</a> by end user browsers. For the jsDelivr Acceptable Use Policy, please visit this <a href="https://www.jsdelivr.com/terms/acceptable-use-policy-jsdelivr-net">link</a>.</p>
<p>The use of TensorFlow runtime code referenced above may be subject to additional license requirements. See the licenses page for TensorFlow.js <a href="https://github.com/tensorflow/tfjs/blob/master/LICENSE">here</a> and TensorFlow.js models <a href="https://github.com/tensorflow/tfjs-models/blob/master/LICENSE">here</a> for details.</p>
<p>Live transcription using the Amazon Chime SDK for JavaScript is powered by Amazon Transcribe. Use of Amazon Transcribe is subject to the <a href="https://aws.amazon.com/service-terms/">AWS Service Terms</a>, including the terms specific to the AWS Machine Learning and Artificial Intelligence Services. Standard charges for Amazon Transcribe and Amazon Transcribe Medical will apply.</p>
<p>You and your end users understand that recording Amazon Chime SDK meetings may be subject to laws or regulations regarding the recording of electronic communications. It is your and your end users’ responsibility to comply with all applicable laws regarding the recordings, including properly notifying all participants in a recorded session, or communication that the session or communication is being recorded, and obtain their consent.</p>
Expand Down
3 changes: 2 additions & 1 deletion docs/modules/backgroundfilter_video_processor.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ <h1>Integrating background blur into your Amazon Chime SDK for JavaScript applic
<h2>What is background blur?</h2>
</a>
<p>The background blur API allows builders to enable background blur on a video stream. To add a background blur to a video stream the builder needs to create a <code>VideoFrameProcessor</code> using <code>BackgroundBlurVideoFrameProcessor</code> and then insert that processor into a <code>VideoTransformDevice</code>. The video frame processor uses a TensorFlow Lite (TFLite) machine learning (ML) model along with JavaScript Web Workers and WebAssembly (WASM) to apply blur to the background of each frame in the video stream. These assets are downloaded at runtime when the video frame processor is created and not provided in the source directly.</p>
<p>Background blur is integrated into the <a href="https://github.com/aws/amazon-chime-sdk-js/tree/master/demos/browser">browser demo</a> application. To try it out, launch the demo with <code>npm run start</code>, join the meeting, click on the camera icon to enable video, then select the video filter drop down and select <code>Background Blur</code>.</p>
<p>Background blur is integrated into the <a href="https://github.com/aws/amazon-chime-sdk-js/tree/main/demos/browser">browser demo</a> application. To try it out, launch the demo with <code>npm run start</code>,
join the meeting, click on the camera icon to enable video, then select the video filter drop down and select <code>Background Blur</code>.</p>
<a href="#background-blur-on-the-web" id="background-blur-on-the-web" style="color: inherit; text-decoration: none;">
<h2>Background blur on the web</h2>
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/contentshare.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ <h3>Content Share</h3>
</div>
<p>This guide explains how to share audio and video content such as screen capture or
media files in a meeting. This guide assumes you have already created a meeting and
added attendees to the meeting (see <a href="https://github.com/aws/amazon-chime-sdk-js/blob/master/README.md#Setup">Setup section</a> in our Readme for more information).</p>
added attendees to the meeting (see <a href="https://github.com/aws/amazon-chime-sdk-js/blob/main/README.md#Setup">Setup section</a> in our Readme for more information).</p>
<p>Content share methods are accessed from the
<a href="https://aws.github.io/amazon-chime-sdk-js/interfaces/audiovideofacade.html">audio-video facade</a>
belonging to the meeting session.</p>
Expand Down
Loading

0 comments on commit 4b21267

Please sign in to comment.