Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the documentation for Echo Reduction #1848

Merged
merged 7 commits into from
Dec 8, 2021
Merged

Conversation

jhaarpan
Copy link
Contributor

@jhaarpan jhaarpan commented Dec 3, 2021

Issue #:

The Echo Reduction documentation needed to be updated to help users change the namespace to the Amazon Chime Meetings SDK

Description of changes:

Added the documentation to show users how to change the namespace to Amazon Chime Meetings SDK to use Echo Reduction.

Testing:

Can these tested using a demo application? Please provide reproducible step-by-step instructions.

Checklist:

  1. Have you successfully run npm run build:release locally?
    Yes

  2. Do you add, modify, or delete public API definitions? If yes, has that been reviewed and approved?
    No

  3. Do you change the wire protocol, e.g. the request method? If yes, has that been reviewed and approved?
    No

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@jhaarpan jhaarpan requested a review from a team as a code owner December 3, 2021 20:22

To create meetings, the following line of code is used to address the namespace:

```typescript
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since you are not using typescript, we can use just js or javascript I think.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be you can update the rest of the doc if not using types, but up to you if you want to change or you want to keep it.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
guides/09_Amazon_Voice_Focus.md Outdated Show resolved Hide resolved
guides/09_Amazon_Voice_Focus.md Outdated Show resolved Hide resolved

Create your meeting by calling the CreateMeeting API and specifying the Echo Reduction flag as `'AVAILABLE'`.

```typescript
// You must migrate to the Amazon Chime SDK Meetings namespace.
const chime = AWS.ChimeSDKMeetings({ region: "eu-central-1" });
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Use single quotes for consistency with other strings in this example.

guides/09_Amazon_Voice_Focus.md Show resolved Hide resolved
@jhaarpan jhaarpan merged commit 2795a54 into master Dec 8, 2021
@jhaarpan jhaarpan deleted the er-doc-update branch December 8, 2021 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants