-
Notifications
You must be signed in to change notification settings - Fork 71
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
Update storybook concept pages to match their corresponding conceptual docs #5613
Changes from 1 commit
b367ad5
4bd6256
bede372
33f45fd
958f757
03a222b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
import { Meta } from '@storybook/addon-docs'; | ||
|
||
<Meta title="Concepts/In Call Notifications" /> | ||
|
||
# In Call Notifications | ||
|
||
Azure Communication Services UI Library is adding support for improved notifications | ||
|
||
In call notifications are essential for providing users with timely and relevant information about their calling experience. | ||
Whether it is an error message, a mute status, or a network quality indicator, notifications can help users troubleshoot issues and improve their communication. | ||
The new feature of ACS UI Library simplifies the display and management of multiple notifications in a consistent and user-friendly way. | ||
The in-call notification feature introduces a streamlined UI experience for displaying errors and notifications in the calling environment. | ||
|
||
## Incorporating In Call Notifications into your Experience | ||
|
||
The UI Library enables users to enhance their video conferencing experiences by providing improved notifications by default within the CallComposite and CallWithChat experiences. | ||
|
||
There are also two Components that have been exposed for this feature: | ||
|
||
[Notification](./?path=/docs/components-notification--doc) | ||
|
||
Notification is a container that shows a notification in a bar format with an icon, title, message, and button. The icon and title are necessary while a message and button are optional. See the example below: | ||
|
||
[NotificationStack](./?path=/docs/components-notificationstack--doc) | ||
|
||
NotificationStack is a wrapper on the Notification component with additional features for surfacing Azure Communication Services notifications on the UI consistently. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,19 +8,33 @@ import MediaAccessRemoteParticipantsText from '!!raw-loader!./snippets/MediaAcce | |
|
||
# Media access | ||
|
||
The media access feature in Teams meetings allows the Organizer, Co-organizer, and Presenter to control whether attendees can enable their mic or camera. | ||
This can be managed through the Teams meeting options “Allow mic/camera for attendees” or on a per-participant basis with the options “Disable mic/camera” and “Enable mic/camera.” | ||
## Overview | ||
|
||
Teams meeting attendees can check their own media access state using the capabilities `unMuteMic` and `turnVideoOn`, or view the media states for remote participants. | ||
Azure Communication Services UI Library is adding support for media access. | ||
This feature allows organizers, co-organizers, and presenters to control the ability of other attendees to send audio and video. | ||
Additionally, users can determine if their audio or video is enabled or disabled and check the media access status of other participants. | ||
This feature allows greater control over meeting environments, minimizing disruptions from unexpected background noise or a disruptive participant. | ||
Here are some example scenarios where hard mute and video mute are useful: | ||
|
||
ACS users must have the Organizer, Co-organizer, or Presenter role to use the media access feature. | ||
During a large virtual visit with multiple doctors, the host can use hard mute to ensure that only the speaker is heard, reducing interruptions. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I heard from PM that hard mute is internal word. From the UI menu we have "Disable mic". There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Updated |
||
|
||
In a virtual banking session, the host can video mute participants to maintain focus on the presentation, ensuring no distractions from video feeds. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. video mute? From UI menu we have "Disable camera". There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Updated |
||
|
||
The supported scenarios for the media access feature are: | ||
|
||
- Teams Interop Meetings | ||
- Teams Interop Meetings as a Teams user | ||
- Teams ad-hoc call | ||
|
||
## How to use Media Access Feature | ||
|
||
The media access feature in Teams meetings allows the Organizer, Co-organizer, and Presenter to control whether attendees can enable their mic or camera. | ||
This can be managed through the Teams meeting options “Allow mic/camera for attendees” or on a per-participant basis with the options “Disable mic/camera” and “Enable mic/camera.” | ||
|
||
Teams meeting attendees can check their own media access state using the capabilities `unMuteMic` and `turnVideoOn`, or view the media states for remote participants. | ||
|
||
ACS users must have the Organizer, Co-organizer, or Presenter role to use the media access feature. | ||
|
||
Participants can disable/enable audio/video using the contextual menu button on their video gallery tile like shown below: | ||
|
||
<img | ||
|
@@ -47,6 +61,10 @@ The concept of the media access feature is the same in Microsoft Teams which you | |
more about here - | ||
[Manage attendee audio and video permissions in Microsoft Teams meetings](https://support.microsoft.com/en-us/office/manage-attendee-audio-and-video-permissions-in-microsoft-teams-meetings-f9db15e1-f46f-46da-95c6-34f9f39e671a). | ||
|
||
## Incorporating Hard Mute and Video Mute into your experience: | ||
|
||
The UI library includes the media access by default within the CallComposite and CallWithChat Composite experiences, so no additional work is required. | ||
|
||
## Listening to local participant `unmuteMic` and `turnVideoOn` capabilities changes | ||
|
||
You can listen to `capabilitiesChanged` events on the CallAdapter or CallWithChatAdapter by defining your own | ||
|
@@ -75,3 +93,17 @@ The example below shows a code snippet where a button is added to invoke the `fo | |
for remote participants from an added dropdown that is populated by remote participants in the call. | ||
|
||
<Source code={CustomMediaAccessCompositeText} /> | ||
|
||
## FAQ: | ||
|
||
### When recording a call or meeting, will the hard Mute or video mute status be included in the recording? | ||
|
||
The recording bot subscribes to the overall audio and video streams, so the muted status will not impact the recording as it is based on the live state during the meeting. | ||
|
||
### What happens when a user is hard muted or video-muted? | ||
|
||
When a user is hard muted, they receive a notification informing them of their muted status. Similarly, when a user is video muted, they receive a notification. Icons indicating the mute status appear next to their name in the participant list and video gallery tile. | ||
|
||
### Can users see who has been muted? | ||
|
||
Yes, users can see muted icons next to the names of participants who have been hard muted, or video muted in the participant list and video gallery tile. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
import { Meta } from '@storybook/addon-docs'; | ||
|
||
<Meta title="Concepts/Raise Hands" /> | ||
|
||
# Raise Hands | ||
|
||
Azure Communication Services UI Library is adding support for Raised Hands. | ||
|
||
With this new feature, users can now raise and lower their hand during a meeting or call. The user can also see the raised hands of other users to know if someone else is looking to speak. Raised hands are displayed prominently in the video gallery but can also be seen on the participant list to be informed of everyone raising their hands on a call. Enabling this feature will enable greater productivity and allow for a better flow of discussions and conversations within calls. Here are some example scenarios where raised hands are useful: | ||
|
||
During a meeting with many participants, the raised hands feature can help the host to manage the conversation and ensure that everyone has a chance to speak. Participants can raise their hands to indicate that they would like to speak, and the host can call on them in order. | ||
|
||
In a call setting, the raised hands feature can be used to signal that an action has been completed by the members of a call. For example, participants can raise their hands to signal that they have completed reading a document that has been shared. This lets the host know they can move on with the meeting. | ||
|
||
## Incorporating Raise Hands into your Experience | ||
|
||
The UI Library enables users to enhance their video conferencing experiences by providing the raised hands feature by default within the CallComposite and CallWithChat experiences. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be Azure Communication Service still. we try to avoid using the acronym in the documentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated