Add mobile SDK MeetingSessionStatusCode handling to FAQ #2890
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
hensmi-amazon
approved these changes
May 6, 2024
linsang21
approved these changes
May 6, 2024
| @@ -78,6 +78,11 @@ | |||
| - [How can I speed up my meeting join times?](#how-can-i-speed-up-my-meeting-join-times) | |||
| - [Messaging](#messaging) | |||
| - [How do I receive Amazon Chime SDK channel messages without using the Amazon Chime SDK for JavaScript?](#how-do-i-receive-amazon-chime-sdk-channel-messages-without-using-the-amazon-chime-sdk-for-javascript) | |||
| - [Mobile SDK](#mobile-sdk) | |||
| - [What does each MeetingSessionStatusCode mean?](#what-does-each-meetingsessionstatuscode-mean) | |||
There was a problem hiding this comment.
nit: Lets backtick the coding naming constructs. For example: MeetingSessionStatusCode here. I see you are using it in some places but suggest to do this overall for consistency.
| - [Mobile SDK](#mobile-sdk) | ||
| - [What does each MeetingSessionStatusCode mean?](#what-does-each-meetingsessionstatuscode-mean) | ||
| - [How should I handle each MeetingSessionStatusCode in my application?](#how-should-i-handle-each-meetingsessionstatuscode-in-my-application) | ||
| - [How to determine if the meeting session stop will be self-recoverable or terminal?](#how-to-determine-if-the-meeting-session-stop-will-be-self-recoverable-or-terminal) |
There was a problem hiding this comment.
nit: the -> a meeting session
| | MeetingSessionStatusCode | Callbacks | How to handle | | ||
| | -------- | ------- | ------- | | ||
| | OK(iOS/Android) | `audioSessionDidStopWithStatus(MeetingSessionStatus)` `videoSessionDidStartWithStatus(MeetingSessionStatus)` `videoSessionDidStopWithStatus(MeetingSessionStatus)` | This code indicates the audio/video sessions on the device have been started/stopped without any errors. When received from AudioVideoObserver callbacks, your application may want to notify your user about the success of session start/stop. |
There was a problem hiding this comment.
- We can probably call out why specific codes are present in Android vs iOS SDK for example the
Leftone for builder clarification. - Probably you may have done so, but, suggest checking the reasoning once with the JS SDK statuses as well and if we need any changes for consistency.
There was a problem hiding this comment.
I don't have enough info to tell why there are discrepancies between iOS and Android, we just want to document what we have at this moment. There is a backlog to investigate and improve those codes.
|
You need to run the |
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 #:
Description of changes:
Added 3 topics to FAQ related to mobile MeetingSessionStatusCode:
Testing:
Can these tested using a demo application? Please provide reproducible step-by-step instructions.
Checklist:
Have you successfully run
npm run build:releaselocally?Do you add, modify, or delete public API definitions? If yes, has that been reviewed and approved?
Do you change the wire protocol, e.g. the request method? If yes, has that been reviewed and approved?
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.