Amazon Chime SDK React 组件库

Amazon Chime SDK 使得在 Web 应用程序中轻松添加协作音频通话、视频通话和屏幕共享功能成为可能，它使用了为数百万 Amazon Chime 在线会议提供支持的相同基础设施服务。

Amazon Chime SDK React 组件库为音频和视频会议应用程序中常用的 Web 界面提供客户端状态管理和可重用的 UI 组件，包括：视频平铺网格、麦克风活动指示器和通话控制。所有组件都采用简洁现代的设计，可以直接使用或通过自定义主题重新设计样式。除了 UI 组件外，该库还利用 React 的状态管理工具（如 Providers 和 Hooks）连接到 Amazon Chime SDK for JavaScript 并将数据传递到 UI 层，简化了状态同步，使开发人员能够专注于构建引人入胜的体验。

有关使用这些 SDK 组件的指南可在 Amazon Chime SDK React 组件库文档中找到。我们的 Storybook 文档还包含了快速入门指南。

Amazon Chime SDK 项目看板展示了我们所有仓库中社区功能请求的状态。看板列的描述在此指南中有所说明。

入门请参阅以下资源

Amazon Chime SDK

Amazon Chime SDK 定价

支持的浏览器

Amazon Chime SDK API 参考

Amazon Chime SDK for JavaScript 文档

从 V1 迁移到 V2

从 V2 迁移到 V3

示例

Amazon Chime 会议演示

消息演示

使用 Amazon Chime SDK React 组件库构建分组讨论室体验

使用 AWS Amplify 快速启动 Amazon Chime SDK 应用程序

安装和开发

如果您要将此库添加到现有应用程序中，请将 amazon-chime-sdk-component-library-react 和必要的对等依赖项添加到您的项目中。

npm install --save amazon-chime-sdk-component-library-react amazon-chime-sdk-js styled-components styled-system

否则，克隆仓库并安装依赖项。

为组件库做贡献

生成依赖项

git clone https://github.com/aws/amazon-chime-sdk-component-library-react.git
npm install

构建

npm run build

构建完成后，检查并解决您可能遇到的任何警告，如未解决的依赖项或循环依赖。删除这些警告将有助于无警告/错误地捆绑库。

在本地运行 Storybook 服务器

amazon-chime-sdk-component-library-react 使用 Storybook 作为文档。

npm start

测试

运行所有单元测试套件。

npm run test

运行单个单元测试套件。

npm run test -- <filepath>

在监视模式下运行所有单元测试套件。

npm run test -- --watch

运行所有快照测试套件。需要 Docker 来在 Docker 容器中运行 Puppeteer。

npm run test:snapshots

故障排除

错误 1：Service 'chromium' failed to build : toomanyrequests: You have reached your pull rate limit

您可能需要创建一个 Docker Hub 账户并验证来自 Docker Hub 的拉取请求。未经身份验证（匿名）的用户将通过 IP 强制执行限制。

错误 2：运行 npm run test:snapshots 时超时

您有两个选择：

设置环境变量 WAIT_ON_TIMEOUT=600000（例如 10 分钟。默认为 5 分钟）。它将在检查服务器响应时等待更长时间。
通过运行 npm start 在本地启动 storybook 服务器，然后运行 npm run test:snapshots。

运行单个快照测试套件，确保在开始测试之前 storybook 服务器在本地运行。

npm run test:snapshots-path -- <filepath>

运行单个快照测试套件并覆盖现有快照。

npm run test:snapshots-path -- <filepath> -u

每次运行 npm run test 结束时都会打印代码覆盖率摘要。完整的覆盖率报告（包括每个文件的覆盖率）会生成为一个可以在浏览器中渲染的 lcov-report html 文件。这个报告在每次测试运行时都会生成在 /coverage 目录中。

故障排除和支持

查看 ReadMe 中提供的资源，并使用我们的客户端文档了解如何开发此库。此外，搜索我们的问题数据库以查看您的问题是否已得到解决。如果没有，请使用提供的模板向我们提出问题。

如果您有更多问题，或需要业务支持，可以联系 AWS 客户支持。您可以在这里查看我们的支持计划。

注意事项

通过此 SDK 使用 Amazon Voice Focus 涉及最终用户在运行时下载和执行代码。

使用 Amazon Voice Focus、Amazon Chime Echo Reduction、背景模糊和背景替换运行时代码需遵守额外的声明。详情请参阅 Amazon Voice Focus NOTICES 文件和背景模糊和背景替换 NOTICES 文件。您同意向通过此 SDK 使用 Amazon Voice Focus 和背景模糊运行时代码的所有最终用户提供这些额外声明。

使用上述提到的 TensorFlow 运行时代码可能需要遵守额外的许可要求。有关详细信息，请参阅 TensorFlow.js 的许可页面此处和 TensorFlow.js 模型此处。

您和您的最终用户对用于背景替换的所有内容（包括任何图像）负责，并且必须确保此类内容不违反法律，不侵犯或滥用任何第三方的权利，也不以其他方式违反您与亚马逊之间协议的重要条款（包括文档、AWS 服务条款或可接受使用政策）。