Promote together mode to stable (#5711)

* Promote together mode to stable

* Update tags to public

* Updated api documentation

* Change files

* Change files

* update stable API

* fix cc

* Change files for beta build

* updated api file for stable

* Update packages/react-composites CallComposite browser test snapshots

---------

Co-authored-by: cnwankwo <[email protected]>
Co-authored-by: dmceachernmsft <[email protected]>
Co-authored-by: Donald McEachern <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: 4 people

change-beta/@azure-communication-react-0bc61add-56be-450e-b76c-7055ee2b919d.json

@@ -0,0 +1,9 @@
+{
+  "type": "prerelease",
+  "area": "feature",
+  "workstream": "together-mode",
+  "comment": "We are excited to announce that the Azure Communication Services Web UI Library now supports Together Mode in Teams interop scenarios. Together Mode is a feature that creates a virtual shared space for meeting participants. By using AI segmentation technology, it places participants in a common background, such as a conference room or auditorium, making it look like everyone is sitting together. This mode is designed to make meetings feel more engaging and reduce virtual meeting fatigue. It can help improve participants' sense of connection and collaboration by mimicking the experience of being in the same physical location. Developers can use this functionality today through our composites (e.g CallComposite, CallWithChatComposite) as well as through components (e.g VideoGallery). Participants receive together Mode in Teams Interop Meetings, change views to and from Together mode and view reactions and raised hands in the Together mode view ",
+  "packageName": "@azure/communication-react",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

change-beta/@azure-communication-react-7fea4da2-61eb-41c5-9733-48ea5e25a3a3.json

@@ -0,0 +1,9 @@
+{
+  "type": "prerelease",
+  "area": "feature",
+  "workstream": "together-mode",
+  "comment": "Promote together mode to stable",
+  "packageName": "@azure/communication-react",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

change-beta/@azure-communication-react-86715e14-10d5-4a70-9e2e-048c3523cc0a.json

@@ -0,0 +1,9 @@
+{
+  "type": "prerelease",
+  "area": "feature",
+  "workstream": "together-mode",
+  "comment": "Promote together mode to stable",
+  "packageName": "@azure/communication-react",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

common/config/babel/features.js

@@ -68,15 +68,15 @@ module.exports = {
     // feature for tracking the callParticipantsLocator
     "call-participants-locator",
     // Feature for RTT
-    "rtt",
-    // Feature for together mode
-    "together-mode"
+    "rtt"
   ],
   stable: [
     // Demo feature. Used in live-documentation of conditional compilation.
     // Do not use in production code.
     "stabilizedDemo",
     // Feature for breakout rooms
-    "breakout-rooms"
+    "breakout-rooms",
+    // Feature for together mode
+    "together-mode"
   ]
 }

packages/calling-component-bindings/src/handlers/createCommonHandlers.ts

@@ -114,30 +114,22 @@ export interface CommonCallingHandlers {
   /* @conditional-compile-remove(together-mode) */
   /**
    * Call back to create a view for together mode
-   *
-   * @beta
    */
   onCreateTogetherModeStreamView: (options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>;
 
   /* @conditional-compile-remove(together-mode) */
   /**
    * Call back to create a view for together mode
-   *
-   * @beta
    */
   onStartTogetherMode: () => Promise<void>;
   /* @conditional-compile-remove(together-mode) */
   /**
    * Call set together mode scene size
-   *
-   * @beta
    */
   onSetTogetherModeSceneSize: (width: number, height: number) => void;
   /* @conditional-compile-remove(together-mode) */
   /**
    * Call back to dispose together mode views
-   *
-   * @beta
    */
   onDisposeTogetherModeStreamView: () => Promise<void>;
   /**

packages/calling-stateful-client/src/CallClientState.ts

@@ -336,63 +336,80 @@ export interface RaiseHandCallFeatureState {
 /* @conditional-compile-remove(together-mode) */
 /**
  * Represents the name of the call feature stream
- * @beta
+ * @public
  */
 export type CallFeatureStreamName = 'togetherMode';
 
 /* @conditional-compile-remove(together-mode) */
 /**
  * State only version of {@link @azure/communication-calling#CallFeatureStream}.
  * Represents call feature stream state.
- * @beta
+ * @public
  */
 export interface CallFeatureStreamState extends RemoteVideoStreamState {
+  /**
+   * The name of the call feature stream.
+   */
   feature?: CallFeatureStreamName;
 }
 
 /* @conditional-compile-remove(together-mode) */
 /**
  * State only version of {@link @azure/communication-calling#TogetherModeSeatingMap}.
- * @beta
+ * @public
  *
  * Represents the seating position of a participant in Together Mode.
  */
 export interface TogetherModeSeatingPositionState {
-  /* The top left offset from the top of the together mode view.*/
+  /**
+   * The top left offset from the top of the together mode view.
+   */
   top: number;
-  /* The left offset position from the left of the together mode view. */
+  /**
+   * The left offset position from the left of the together mode view.
+   */
   left: number;
-  /*  The width of the seating area */
+  /**
+   * The width of the seating area
+   */
   width: number;
-  /* The height of the seating area. */
+  /**
+   * The height of the seating area.
+   */
   height: number;
 }
 
 /* @conditional-compile-remove(together-mode) */
 /**
  * Represents the seating positions of participants in Together Mode.
  *
- * @beta
+ * @public
  */
 export type TogetherModeParticipantSeatingState = Record<string, TogetherModeSeatingPositionState>;
 
 /* @conditional-compile-remove(together-mode) */
 /**
  * Represents the streams in Together Mode.
  *
- * @beta
+ * @public
  */
 export interface TogetherModeStreamsState {
+  /**
+   * The main video stream in Together Mode.
+   */
   mainVideoStream?: CallFeatureStreamState;
 }
 
 /* @conditional-compile-remove(together-mode) */
 /**
  * State only version of {@link @azure/communication-calling#TogetherModeCallFeature}. {@link StatefulCallClient}.
  * Represents the state of the Together Mode feature.
- * @beta
+ * @public
  */
 export interface TogetherModeCallFeatureState {
+  /**
+   * Flag indicating if Together Mode is active in the call
+   */
   isActive: boolean;
   /**
    * Proxy of {@link @azure/communication-calling#TogetherModeCallFeature.togetherModeStream}.
@@ -736,7 +753,6 @@ export interface CallState {
   /* @conditional-compile-remove(together-mode) */
   /**
    * Proxy of {@link @azure/communication-calling#TogetherModeCallFeature}.
-   * @beta
    */
   togetherMode: TogetherModeCallFeatureState;
   /**

packages/communication-react/review/beta/communication-react.api.md

@@ -444,14 +444,12 @@ export interface CallAdapterCallOperations {
     addParticipant(participant: CommunicationUserIdentifier): Promise<void>;
     allowUnsupportedBrowserVersion(): void;
     createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>;
-    // @beta
     createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>;
     disposeLocalVideoStreamView(): Promise<void>;
     disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>;
     disposeScreenShareStreamView(remoteUserId: string): Promise<void>;
     // @deprecated
     disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>;
-    // @beta
     disposeTogetherModeStreamView(): Promise<void>;
     forbidAudio(userIds: string[]): Promise<void>;
     forbidOthersAudio(): Promise<void>;
@@ -477,14 +475,12 @@ export interface CallAdapterCallOperations {
     sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>;
     setCaptionLanguage(language: string): Promise<void>;
     setSpokenLanguage(language: string): Promise<void>;
-    // @beta
     setTogetherModeSceneSize(width: number, height: number): void;
     startCamera(options?: VideoStreamOptions): Promise<void>;
     startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>;
     startNoiseSuppressionEffect(): Promise<void>;
     startScreenShare(): Promise<void>;
     startSpotlight(userIds?: string[]): Promise<void>;
-    // @beta
     startTogetherMode(): Promise<void>;
     startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>;
     stopAllSpotlight(): Promise<void>;
@@ -1111,12 +1107,11 @@ export type CallErrors = {
 // @public
 export type CallErrorTarget = 'Call.addParticipant' | 'Call.dispose' | 'Call.feature' | 'Call.hangUp' | 'Call.hold' | 'Call.mute' | 'Call.muteIncomingAudio' | 'Call.off' | 'Call.on' | 'Call.removeParticipant' | 'Call.resume' | 'Call.sendDtmf' | 'Call.startAudio' | 'Call.startScreenSharing' | 'Call.startVideo' | 'Call.stopScreenSharing' | 'Call.stopAudio' | 'Call.stopVideo' | 'Call.unmute' | 'Call.unmuteIncomingAudio' | 'CallAgent.dispose' | 'CallAgent.feature' | 'CallAgent.join' | 'CallAgent.off' | 'CallAgent.on' | 'CallAgent.startCall' | 'CallClient.createCallAgent' | 'CallClient.createTeamsCallAgent' | 'CallClient.feature' | 'CallClient.getDeviceManager' | 'CallClient.getEnvironmentInfo' | 'DeviceManager.askDevicePermission' | 'DeviceManager.getCameras' | 'DeviceManager.getMicrophones' | 'DeviceManager.getSpeakers' | 'DeviceManager.off' | 'DeviceManager.on' | 'DeviceManager.selectMicrophone' | 'DeviceManager.selectSpeaker' | 'IncomingCall.accept' | 'IncomingCall.reject' | 'TeamsCall.addParticipant' | 'VideoEffectsFeature.startEffects' | /* @conditional-compile-remove(calling-beta-sdk) */ 'CallAgent.handlePushNotification' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.admit' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.rejectParticipant' | /* @conditional-compile-remove(calling-beta-sdk) */ 'Call.admitAll' | 'Call.mutedByOthers' | 'Call.muteAllRemoteParticipants' | 'Call.setConstraints';
 
-// @beta
+// @public
 export type CallFeatureStreamName = 'togetherMode';
 
-// @beta
+// @public
 export interface CallFeatureStreamState extends RemoteVideoStreamState {
-    // (undocumented)
     feature?: CallFeatureStreamName;
 }
 
@@ -1255,7 +1250,6 @@ export interface CallState {
     spotlight?: SpotlightCallFeatureState;
     startTime: Date;
     state: CallState_2;
-    // @beta
     togetherMode: TogetherModeCallFeatureState;
     totalParticipantCount?: number;
     transcription: TranscriptionCallFeature;
@@ -1282,7 +1276,6 @@ export interface CallWithChatAdapterManagement {
     allowUnsupportedBrowserVersion(): void;
     askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>;
     createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>;
-    // @beta
     createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>;
     // @beta
     deleteImage(imageId: string): Promise<void>;
@@ -1291,7 +1284,6 @@ export interface CallWithChatAdapterManagement {
     disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>;
     disposeScreenShareStreamView(remoteUserId: string): Promise<void>;
     disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>;
-    // @beta
     disposeTogetherModeStreamView(): Promise<void>;
     // (undocumented)
     downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>;
@@ -1335,7 +1327,6 @@ export interface CallWithChatAdapterManagement {
     setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>;
     setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>;
     setSpokenLanguage(language: string): Promise<void>;
-    // @beta
     setTogetherModeSceneSize(width: number, height: number): void;
     startCall(participants: string[], options?: StartCallOptions): Call | undefined;
     startCall(participants: (MicrosoftTeamsAppIdentifier | PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier)[], options?: StartCallOptions): Call | undefined;
@@ -1344,7 +1335,6 @@ export interface CallWithChatAdapterManagement {
     startNoiseSuppressionEffect(): Promise<void>;
     startScreenShare(): Promise<void>;
     startSpotlight(userIds?: string[]): Promise<void>;
-    // @beta
     startTogetherMode(): Promise<void>;
     startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>;
     stopAllSpotlight(): Promise<void>;
@@ -2394,7 +2384,6 @@ export interface CommonCallingHandlers {
     onCreateLocalStreamView: (options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>;
     // (undocumented)
     onCreateRemoteStreamView: (userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>;
-    // @beta
     onCreateTogetherModeStreamView: (options?: TogetherModeStreamOptions) => Promise<void | TogetherModeStreamViewResult>;
     // (undocumented)
     onDisposeLocalScreenShareStreamView: () => Promise<void>;
@@ -2406,7 +2395,6 @@ export interface CommonCallingHandlers {
     onDisposeRemoteStreamView: (userId: string) => Promise<void>;
     // (undocumented)
     onDisposeRemoteVideoStreamView: (userId: string) => Promise<void>;
-    // @beta
     onDisposeTogetherModeStreamView: () => Promise<void>;
     onForbidAudio?: (userIds: string[]) => Promise<void>;
     onForbidOthersAudio?: () => Promise<void>;
@@ -2452,7 +2440,6 @@ export interface CommonCallingHandlers {
     onSetCaptionLanguage: (language: string) => Promise<void>;
     // (undocumented)
     onSetSpokenLanguage: (language: string) => Promise<void>;
-    // @beta
     onSetTogetherModeSceneSize: (width: number, height: number) => void;
     // (undocumented)
     onStartCall: (participants: CommunicationIdentifier[], options?: StartCallOptions) => void;
@@ -2466,7 +2453,6 @@ export interface CommonCallingHandlers {
     onStartScreenShare: () => Promise<void>;
     // (undocumented)
     onStartSpotlight: (userIds?: string[]) => Promise<void>;
-    // @beta
     onStartTogetherMode: () => Promise<void>;
     // (undocumented)
     onStopAllSpotlight: () => Promise<void>;
@@ -4250,9 +4236,7 @@ export interface NotificationStackStrings {
     stopScreenShareGeneric?: NotificationStrings;
     stopVideoGeneric?: NotificationStrings;
     teamsMeetingCallNetworkQualityLow?: NotificationStrings;
-    // (undocumented)
     togetherModeEnded?: NotificationStrings;
-    // (undocumented)
     togetherModeStarted?: NotificationStrings;
     transcriptionStarted?: NotificationStrings;
     transcriptionStopped?: NotificationStrings;
@@ -5340,44 +5324,36 @@ export type TeamsOutboundCallAdapterArgs = TeamsCallAdapterArgsCommon & {
 // @public
 export const toFlatCommunicationIdentifier: (identifier: CommunicationIdentifier) => string;
 
-// @beta
+// @public
 export interface TogetherModeCallFeatureState {
-    // (undocumented)
     isActive: boolean;
     seatingPositions: TogetherModeParticipantSeatingState;
     streams: TogetherModeStreamsState;
 }
 
-// @beta
+// @public
 export type TogetherModeParticipantSeatingState = Record<string, TogetherModeSeatingPositionState>;
 
-// @beta
+// @public
 export interface TogetherModeSeatingPositionState {
-    // (undocumented)
     height: number;
-    // (undocumented)
     left: number;
-    // (undocumented)
     top: number;
-    // (undocumented)
     width: number;
 }
 
-// @beta
+// @public
 export interface TogetherModeStreamOptions extends VideoStreamOptions {
-    // (undocumented)
     viewKind?: 'main' | 'panoramic';
 }
 
-// @beta
+// @public
 export interface TogetherModeStreamsState {
-    // (undocumented)
     mainVideoStream?: CallFeatureStreamState;
 }
 
-// @beta
+// @public
 export interface TogetherModeStreamViewResult {
-    // (undocumented)
     mainVideoView?: CreateVideoStreamViewResult;
 }
 
@@ -5754,24 +5730,19 @@ export interface VideoGalleryStyles extends BaseCustomStyles {
     verticalGallery?: VerticalGalleryStyles;
 }
 
-// @beta
+// @public
 export type VideoGalleryTogetherModeParticipantPosition = Record<string, VideoGalleryTogetherModeSeatingInfo>;
 
-// @beta
+// @public
 export interface VideoGalleryTogetherModeSeatingInfo {
-    // (undocumented)
     height: number;
-    // (undocumented)
     left: number;
-    // (undocumented)
     top: number;
-    // (undocumented)
     width: number;
 }
 
-// @beta
+// @public
 export interface VideoGalleryTogetherModeStreams {
-    // (undocumented)
     mainVideoStream?: VideoGalleryStream;
 }