Skip to content

Update FAQ for updated meeting events #3039

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update FAQ for updated meeting events #3039

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions docs/modules/faqs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -722,10 +722,15 @@ <h3>How should I handle each <code>MeetingSessionStatusCode</code> in my applica
<td>Your application not be receiving this code directly, <code>AudioVideoObserver.connectionDidBecomePoor()</code> will be triggered instead. You can subscribe to this callback and notify your application user about the network issue, however, you should not retry connect the meeting session, Chime SDK will handle it. When retries are exhausted, the meeting session will stop completely, <code>audioSessionDidStopWithStatus(MeetingSessionStatus)</code> will be triggered then.</td>
</tr>
<tr>
<td>audioServerHungup(iOS) audioServiceUnavailable(iOS) AudioServiceUnavailable(Android)</td>
<td>audioServiceUnavailable(iOS) AudioServiceUnavailable(Android)</td>
<td><code>audioSessionDidStopWithStatus(MeetingSessionStatus)</code></td>
<td>There is an issue with Amazon Chime SDK service itself, the meeting session on the device has been terminated at this point, you will not be able to rejoin, your application should notify user about the session termination. Depends on your application design/user-flow, you could re-try/re-join the session, however, this may not work if the issue is not transient.</td>
</tr>
<tr>
<td>audioServerHungup(iOS) AudioServerHungup(Android)</td>
<td><code>audioSessionDidStopWithStatus(MeetingSessionStatus)</code></td>
<td>The Chime SDK meeting ended. This is often due to DeleteMeeting API being called on the meeting.</td>
</tr>
<tr>
<td>audioJoinedFromAnotherDevice(iOS) AudioJoinedFromAnotherDevice(Android)</td>
<td><code>audioSessionDidStopWithStatus(MeetingSessionStatus)</code></td>
Expand Down Expand Up @@ -818,12 +823,19 @@ <h3>How to reproduce each <code>MeetingSessionStatusCode</code>?</h3>
<td>During a valid call session, disconnect the network on your iOS/Android device.</td>
</tr>
<tr>
<td>audioServerHungup(iOS) audioServiceUnavailable(iOS) AudioServiceUnavailable(Android)</td>
<td>audioServiceUnavailable(iOS) AudioServiceUnavailable(Android)</td>
<td>Chime SDK service issue, cannot be reproduced on your mobile device.</td>
<td>N/A</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td>audioServerHungup(iOS) AudioServerHungup(Android)</td>
<td>The Chime SDK meeting ended. This is often due to DeleteMeeting API being called on the meeting.</td>
<td>N/A</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td>audioJoinedFromAnotherDevice(iOS) AudioJoinedFromAnotherDevice(Android)</td>
<td>During a valid call session, use the same meeting join info to join the call on another device, the callback will be called on the original device.</td>
Expand Down
6 changes: 4 additions & 2 deletions guides/07_FAQs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -647,7 +647,8 @@ These status codes can be used for logging, debugging, and notification to end u
| 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.
| Left(Android) | `audioSessionDidStopWithStatus(MeetingSessionStatus)` `videoSessionDidStopWithStatus(MeetingSessionStatus)` | It indicates the meeting session on the device has been disconnected due to the attendee leave, nothing to handle except notify your application user about the session stop. |
| networkBecomePoor(iOS) NetworkBecamePoor(Android) | `connectionDidBecomePoor()` | Your application not be receiving this code directly, `AudioVideoObserver.connectionDidBecomePoor()` will be triggered instead. You can subscribe to this callback and notify your application user about the network issue, however, you should not retry connect the meeting session, Chime SDK will handle it. When retries are exhausted, the meeting session will stop completely, `audioSessionDidStopWithStatus(MeetingSessionStatus)` will be triggered then. |
| audioServerHungup(iOS) audioServiceUnavailable(iOS) AudioServiceUnavailable(Android) | `audioSessionDidStopWithStatus(MeetingSessionStatus)` | There is an issue with Amazon Chime SDK service itself, the meeting session on the device has been terminated at this point, you will not be able to rejoin, your application should notify user about the session termination. Depends on your application design/user-flow, you could re-try/re-join the session, however, this may not work if the issue is not transient. |
| audioServiceUnavailable(iOS) AudioServiceUnavailable(Android) | `audioSessionDidStopWithStatus(MeetingSessionStatus)` | There is an issue with Amazon Chime SDK service itself, the meeting session on the device has been terminated at this point, you will not be able to rejoin, your application should notify user about the session termination. Depends on your application design/user-flow, you could re-try/re-join the session, however, this may not work if the issue is not transient. |
| audioServerHungup(iOS) AudioServerHungup(Android) | `audioSessionDidStopWithStatus(MeetingSessionStatus)` | The Chime SDK meeting ended. This is often due to DeleteMeeting API being called on the meeting.
| audioJoinedFromAnotherDevice(iOS) AudioJoinedFromAnotherDevice(Android) | `audioSessionDidStopWithStatus(MeetingSessionStatus)` | The attendee joined the meeting from another device. The meeting session on current device has been disconnected, your application should not retry connecting. |
| audioInternalServerError(iOS) | `audioSessionDidStopWithStatus(MeetingSessionStatus)` | When received the code from the callback, the meeting session on the device has been terminated due to audio issues, the issue could be audio device related, or with Amazon Chime SDK service itself, you will not be able to rejoin the meeting, your application should notify user about the session termination. |
| audioAuthenticationRejected(iOS) AudioAuthenticationRejected(Android) | `audioSessionDidStopWithStatus(MeetingSessionStatus)` | When received this code from the callback, the meeting session on the device has been terminated because the attendee information is invalid, you will not be able to rejoin the meeting, your application should notify user about the session termination. |
Expand All @@ -668,7 +669,8 @@ Below is the list of `MeetingSessionStatusCode` that you can reproduce for each
| OK(iOS/Android) | During a valid call session, call meetingsession.audioVideo.stop(). | With a valid meeting join info, call meetingSession.audioVideo.start(). | During a valid call session, call meetingsession.audioVideo.stop(). | N/A |
| Left(Android) | N/A | N/A | N/A | N/A |
| networkBecomePoor(iOS) NetworkBecamePoor(Android) | N/A | N/A | N/A | During a valid call session, disconnect the network on your iOS/Android device. |
| audioServerHungup(iOS) audioServiceUnavailable(iOS) AudioServiceUnavailable(Android) | Chime SDK service issue, cannot be reproduced on your mobile device. | N/A | N/A | N/A |
| audioServiceUnavailable(iOS) AudioServiceUnavailable(Android) | Chime SDK service issue, cannot be reproduced on your mobile device. | N/A | N/A | N/A |
| audioServerHungup(iOS) AudioServerHungup(Android) | The Chime SDK meeting ended. This is often due to DeleteMeeting API being called on the meeting. | N/A | N/A | N/A |
| audioJoinedFromAnotherDevice(iOS) AudioJoinedFromAnotherDevice(Android) | During a valid call session, use the same meeting join info to join the call on another device, the callback will be called on the original device. | N/A | N/A | N/A |
| audioInternalServerError(iOS) | Chime SDK service issue, cannot be reproduced on mobile device. | N/A | N/A | N/A |
| audioAuthenticationRejected(iOS) AudioAuthenticationRejected(Android) | Use an invalid join token([link](https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_Attendee.html#chimesdk-Type-meeting-chime_Attendee-JoinToken)) to join the call. | N/A | N/A | N/A |
Expand Down