amazon-chime-sdk-js

Amazon Chime SDK for JavaScript

Amazon Chime SDK Project Board

Amazon Chime SDK React Components

Build video calling, audio calling, messaging, and screen sharing applications powered by the Amazon Chime SDK

The Amazon Chime SDK is a set of real-time communications components that developers can use to quickly add messaging, audio, video, and screen sharing capabilities to their web or mobile applications.

Developers can build on AWS's global communications infrastructure to deliver engaging experiences in their applications. For example, they can add video to a health application so patients can consult remotely with doctors on health issues, or create customized audio prompts for integration with the public telephone network.

The Amazon Chime SDK for JavaScript works by connecting to meeting session resources that you create in your AWS account. The SDK has everything you need to build custom calling and collaboration experiences in your web application, including methods to configure meeting sessions, list and select audio and video devices, start and stop screen share and screen share viewing, receive callbacks when media events such as volume changes occur, and control meeting features such as audio mute and video tile bindings.

If you are building a React application, consider using the Amazon Chime SDK React Component Library that supplies client-side state management and reusable UI components for common web interfaces used in audio and video conferencing applications. Amazon Chime also offers Amazon Chime SDK for iOS and Amazon Chime SDK for Android for native mobile application development.

The Amazon Chime SDK Project Board captures the status of community feature requests across all our repositories. The descriptions of the columns on the board are captured in this guide.

Resources

• Amazon Chime SDK Overview
• Understanding security in Amazon Chime Application and SDK
• Pricing
• Supported Browsers
• Getting Started Guides
• Developer Guide
• Control Plane API Reference
• Frequently Asked Questions (FAQ)

Blog posts

In addition to the below, here is a list of all blog posts about the Amazon Chime SDK.

Frontend

• Transforming Audio and Shared Content
• Quickly Launch an Amazon Chime SDK Application With AWS Amplify

Full stack and PSTN

• Capturing Amazon Chime SDK Meeting Content
• Monitoring and Troubleshooting With Amazon Chime SDK Meeting Events
• Build Meetings features into your Amazon Chime SDK messaging application
• Using the Amazon Chime SDK to Create Automated Outbound Call Notifications
• Building voice menus and call routing with the Amazon Chime SDK

Messaging

• Use channel flows to remove profanity and sensitive content from messages in Amazon Chime SDK messaging
• Automated Moderation and Sentiment Analysis Blog (example using Kinesis Data Streams)
• Build chat applications in iOS and Android with Amazon Chime SDK messaging
• Building chat features into your application with Amazon Chime SDK messaging
• Integrate your Identity Provider with Amazon Chime SDK Messaging
• Creating Read-Only Chat Channels for Announcements
• Real-time Collaboration Using Amazon Chime SDK messaging
• Building a Live Streaming Chat Application

Media Pipelines

• Capture Amazon Chime SDK Meetings Using Media Capture Pipelines
• Amazon Chime SDK launches live connector for streaming

Webinars and videos

• Webinar: Creating Classroom Experiences Using the Amazon Chime SDK

JavaScript SDK Guides

The following developer guides cover specific topics for a technical audience.

• API Overview
• Frequently Asked Questions (FAQ)
• Content Share
• Quality, Bandwidth, and Connectivity
• Simulcast
• Meeting Events
• Integrating Amazon Voice Focus and Echo Reduction Into Your Application
• Adding Frame-By-Frame Processing to an Outgoing Video Stream
• Adding Background Filtering to an Outgoing Video Stream
• Adapting Video to Limited Bandwidth Using a Priority-Based Video Downlink Policy
• Client Event Ingestion
• Content Security Policy
• Managing Video Quality for Different Video Layouts

Migration Guides

• Migration from V1.0 to V2.0
• Migration from V2.0 to V3.0

Developer Guides

The following developer guides cover the Amazon Chime SDK more broadly.

• Messaging developer guide
• Media Pipelines developer guide

Examples

• Amazon Chime SDK Samples — Amazon Chime SDK Samples repository
• Meeting Demo — A browser meeting application with a local server
• Serverless Meeting Demo — A self-contained serverless meeting application
• Single JS — A script to bundle the SDK into a single .js file
• Transcription and Media Capture Demo - A demo to demonstrate transcription and media capture capabilities
• Virtual Classroom — An online classroom built with Electron and React
• Live Events — Interactive live events solution
• Amazon Chime SDK Smart Video Sending Demo — Demo showcasing how to dynamically display up to 25 video tiles from a pool of up to 250 meeting attendees
• Amazon Chime SDK and Amazon Connect Integration — Build a video contact center with Amazon Connect and Amazon Chime SDK
• Device Integration — Using the Amazon Chime SDK for 3rd party devices
• Messaging — Build chat features into your application with Amazon Chime SDK messaging
• Load Testing Applications — A tool to load test audio-video communication applications

PSTN Audio Examples

• PSTN Dial In — Add PSTN dial-in capabilities to your Amazon Chime SDK Meeting using SIP media application
• Outbound Call Notifications — Send meeting reminders with SIP media application and get real time results back
• Update In-Progress Call - Update an in-progress SIP media application call via API call

Troubleshooting and Support

Review the resources given in the README and use our client documentation for guidance on how to develop on the Chime SDK for JavaScript. Additionally, search our issues database and [FAQs](https://aws.github.io/amazon-chime-sdk-js/modules/faqs