Updated guides and doc-strings to recommend VideoPriorityBasedPolicy over VideoAdaptiveProbePolicy
#2959
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…` over `VideoAdaptiveProbePolicy`
hensmi-amazon
commented
Sep 27, 2024
| @@ -157,22 +157,16 @@ You can also observe the [connectionDidSuggestStopVideo](https://aws.github.io/a | |||
|
|
|||
| The SDK by default uses the [NScaleVideoUplinkBandwidthPolicy](https://aws.github.io/amazon-chime-sdk-js/classes/nscalevideouplinkbandwidthpolicy.html) which monitors number of participants in the meeting and automatically scales down the maxBandwidthKbps as the number of remote video tiles increases. This can be customized by implementing a [VideoUplinkBandwidth Policy](https://aws.github.io/amazon-chime-sdk-js/classes/meetingsessionconfiguration.html#videouplinkbandwidthpolicy) and setting it in the [MeetingSessionConfiguration](https://aws.github.io/amazon-chime-sdk-js/classes/meetingsessionconfiguration.html#videouplinkbandwidthpolicy) class. | |||
|
|
|||
| #### Pause remote attendee video | |||
|
|
|||
| When more video is being received than available estimated downlink bandwidth can support, the event [videoNotReceivingEnoughData](https://aws.github.io/amazon-chime-sdk-js/interfaces/audiovideoobserver.html#videonotreceivingenoughdata) can is triggered with a list of attendee IDs and the bandwidth being consumed due to them. You can use this information to selectively pause attendees that are sending the highest bitrate video streams using [pauseVideoTile](https://aws.github.io/amazon-chime-sdk-js/interfaces/audiovideofacade.html#pausevideotile). When a video tile is paused, the action only affects your client. It does not pause the video for other attendees. | |||
There was a problem hiding this comment.
This recommendation is really wacky. Had to remove it.
hensmi-amazon
commented
Sep 27, 2024
| @@ -5,9 +5,7 @@ The uplink policy controls the configuration of the renditions through camera ca | |||
|
|
|||
| Simulcast is currently disabled by default. To enable it [MeetingSessionConfiguration.enableSimulcastForUnifiedPlanChromiumBasedBrowsers](https://aws.github.io/amazon-chime-sdk-js/classes/meetingsessionconfiguration.html#enablesimulcastforunifiedplanchromiumbasedbrowsers) must be set. Currently, only Chrome 76 and above is supported. | |||
|
|
|||
| The [VideoAdaptiveProbePolicy](https://aws.github.io/amazon-chime-sdk-js/classes/videoadaptiveprobepolicy.html) downlink policy adaptively subscribes to the best simulcast layer and is automatically selected if [[MeetingSessionConfiguration.enableSimulcastForUnifiedPlanChromiumBasedBrowsers](https://aws.github.io/amazon-chime-sdk-js/classes/meetingsessionconfiguration.html#enablesimulcastforunifiedplanchromiumbasedbrowsers) is set to true. | |||
There was a problem hiding this comment.
I'm considering this a point against the pattern of the magic bool that under-the-hood turns on a bunch of features. Future change compatibility seems like it will almost always be an issue.
hensmi-amazon
commented
Sep 27, 2024
|
|
||
| 1. Message from infrastructure enumerating video streams from each remote client | ||
| 2. Estimated downlink bandwidth from WebRTC library | ||
| 3. Media metrics such as packet loss and used bandwidth |
There was a problem hiding this comment.
This section has way too many lower level details that builders don't need, so i didn't move them over to the other guide.
hensmi-amazon
commented
Sep 27, 2024
| /** | ||
| * [[VideoAdaptiveProbePolicy]] wraps [[VideoPriorityBasedPolicy]] with customized behavior to automatically | ||
| * assign a high preference to content share. This is a legacy policy used by default when simulcast is enabled, but | ||
| * all customers should be using `VideoPriorityBasedPolicy` instead, since this policy does not work with |
There was a problem hiding this comment.
It's not that its impossible to make it work. Just that no customers were using this policy at the time I released SSNA (though we occasionally get questions about this policy vs the priority policy) so i didn't see the purpose in backporting it.
michhyun1
approved these changes
Sep 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #: N/A
Description of changes:
Title. I also cleaned up some other sections of the guide.
Testing:
N/A
Can these tested using a demo application? Please provide reproducible step-by-step instructions.
No
Checklist:
Have you successfully run
npm run build:releaselocally?y
Do you add, modify, or delete public API definitions? If yes, has that been reviewed and approved?
n
Do you change the wire protocol, e.g. the request method? If yes, has that been reviewed and approved?
n
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.