amazon-chime-sdk-js
Advanced tools
The Amazon Chime SDK makes it easy to add collaborative audio calling, video calling, and screen share features to web applications by using the same infrastructure services that power millions of Amazon Chime online meetings.
This Amazon Chime SDK for JavaScript works by connecting to meeting session resources that you have created 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 occur such as volume changes, and control meeting features such as audio mute and video tile bindings.
To get started, see the following resources:
To build, test, and run demos from source you will need:
npm install amazon-chime-sdk-js --save
To run demo applications see the README.md file
in the demos/browser folder. To run the meeting application
demo locally:
Ensure you have AWS credentials configured in your ~/.aws folder for a
role with a policy allowing chime:CreateMeeting, chime:DeleteMeeting, and
chime:CreateAttendee.
Change to the demos/browser folder: cd demos/browser
Start the demo application: npm run start
Open http://localhost:8080 in your browser.
You can deploy any of the demos as self-contained serverless applications. Note: deploying the serverless demo may incur extra charges in your AWS account.
The following will create a CloudFormation stack containing a Lambda and
API Gateway deployment that runs the meeting demo.
cd demos/serverless
node ./deploy.js -r us-east-1 -b <my-bucket> -s <my-stack-name> -a meeting
The script will create an S3 bucket and CloudFormation stack with Lambda and API Gateway resources required to run the demo. After the script finishes, it will output a URL that can be opened in a browser.
npm run build
npm run test
After running npm run test the first time, you can use npm run test:fast to
speed up the test suite.
To view code coverage results open build/coverage/index.html in your browser
after running npm run test.
To generate JavaScript API reference documentation run:
npm run doc
Then open doc/api/index.html in your browser.
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public GitHub issue.
Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
[1.0.0] - 2019-11-20
FAQs
Amazon Chime SDK for JavaScript
The npm package amazon-chime-sdk-js receives a total of 16,630 weekly downloads. As such, amazon-chime-sdk-js popularity was classified as popular.
We found that amazon-chime-sdk-js demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket is tracking a new trend where malicious actors are now exploiting the popularity of LLM research to spread malware through seemingly useful open source packages.
Security News
Research
Noxia, a new dark web bulletproof host, offers dirt cheap servers for Python, Node.js, Go, and Rust, enabling cybercriminals to distribute malware and execute supply chain attacks.
Company News
Socket safeguards companies from software supply chain attacks by detecting and preventing threats in open source code and empowering developers to secure their applications and critical services against malware and other security risks.