Skip to content

Latest commit

 

History

History
121 lines (87 loc) · 5.93 KB

README.md

File metadata and controls

121 lines (87 loc) · 5.93 KB
Raw

Browser Meeting

This demo shows how to use the Amazon Chime SDK to build meeting applications for browsers.

Prerequisites

To build, test, and run demos from source you will need:

  • Node 18 or higher
  • npm 8.6.0 or higher

Ensure you have AWS credentials configured in your ~/.aws folder for a role with a policy allowing chime:CreateMeeting, chime:DeleteMeeting, and chime:CreateAttendee.

If you want to use media capture in meetingV2, the role policy will also require chime:CreateMediaCapturePipeline, chime:DeleteMediaCapturePipeline, and s3:GetBucketPolicy. In addition, ensure that an S3 ARN for a bucket owned by the same AWS account that your credentials are for should be set in the CAPTURE_S3_DESTINATION environment variable. The S3 bucket should be in the same AWS region as the meeting and have the following bucket policy:

{
    "Version": "2012-10-17",
    "Id":"AWSChimeMediaCaptureBucketPolicy",
    "Statement": [
        {
            "Sid": "AWSChimeMediaCaptureBucketPolicy",
            "Effect": "Allow",
            "Principal": {
                "Service": "chime.amazonaws.com"
            },
            "Action": ["s3:PutObject", "s3:PutObjectAcl"],
            "Resource":"arn:aws:s3:::[bucket name]/*"
        }
    ]
}

To use the Amazon Chime SDK media pipelines live connector feature, you need to provide an Amazon Interactive Video Service (IVS) channel endpoint and set the environment variable when running locally. IVS channel is created in only in the serverless browser demo and not in local browser demo. For example:

export IVS_ENDPOINT=<rtmps://ingest-server-url:443/app/stream-key>

Check Amazon Chime SDK launches live connector for streaming blog post for more information.

For messaging session, make sure your role policy contains chime:Connect and chime:GetMessagingSessionEndpoint.

Running the browser demos with a local server

  1. Navigate to the demos/browser folder: cd demos/browser

  2. Start the demo application: npm run start

Note: Once the demo is run for the first time, you can run the application in hot reload mode by calling npm run start:hot.

  1. Open http://localhost:8080 in your browser.

The meeting created with a local server is only available within your browser.

Changes to meetingV2.html and meetingV2.ts will be hot-reloaded. To force changes to the library itself to be hot-reloaded, run npm run tsc:watch in the SDK repository root.

Demo applications

Browser demo applications are located in the app folder. Current demos are:

  • meetingV2 (default) - incorporates all functionality into a videoconferencing application with a Bootstrap user interface and content share functionality
  • meetingReadinessChecker - Meeting readiness checker app helps developers ensure that end-users can join Amazon Chime SDK meetings from their devices
  • messagingSession - Messaging session app shows developers how to create and use messaging session and related APIs.

To run a specific demo application use:

npm run start --app=<app>

For example,

  1. To run the meeting demo, run: 
    npm run start --app=meeting
  2. To run the meetingReadinessChecker demo, run: 
    npm run start --app=meetingReadinessChecker
  3. To run the messagingSession demo, run: 
    npm run start --app=messagingSession

If you don't specify the --app option, it will run the meetingV2 demo.

When using npm v7 or higher, use --env instead of --app:

npm run start:hot -- --env app=meetingReadinessChecker
npm run build -- --env app=meetingV2

start:fast is not currently supported for apps other than meetingV2 with npm v7.

After running start the first time, you can speed things up on subsequent iterations by using start:fast, e.g.

npm run start:fast (--app=<app>)

Providing a custom application metadata

Amazon Chime SDK for JavaScript allows builders to provide application metadata in the meeting session configuration. This field is optional. Amazon Chime uses application metadata to analyze meeting health trends or identify common failures to improve your meeting experience.

⚠️ Do not pass any Personal Identifiable Information (PII).

The demo meetingV2 app is using amazon-chime-sdk-js-demo as the appName and 2.0.0 as the appVersion for building the application metadata. To provide a custom application metadata, please follow providing application metadata usage section.

Notice

The browser demo applications in the demos directory use TensorFlow.js and pre-trained TensorFlow.js models for image segmentation. Use of these third party models involves downloading and execution of code at runtime from jsDelivr by end user browsers. For the jsDelivr Acceptable Use Policy, please visit this link.

The use of TensorFlow runtime code referenced above may be subject to additional license requirements. See the licenses page for TensorFlow.js here and TensorFlow.js models here for details.

Disclaimer: You and your end users understand that recording Amazon Chime SDK meetings with this demo 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.