@azure/communication-react 1.7.1-alpha-202308170011 → 1.7.1-alpha-202308172328

package/dist/communication-react.d.ts

@@ -85,7 +85,6 @@ import { PersonaSize } from '@fluentui/react';
 import { PhoneNumberIdentifier } from '@azure/communication-common';
 import { PhoneNumberKind } from '@azure/communication-common';
 import { PropertyChangedEvent } from '@azure/communication-calling';
-import { RaisedHand as RaisedHand_2 } from '@azure/communication-calling';
 import { default as React_2 } from 'react';
 import type { RemoteParticipant } from '@azure/communication-calling';
 import { RemoteParticipantState as RemoteParticipantState_2 } from '@azure/communication-calling';
@@ -745,6 +744,18 @@ export declare interface CallAdapterCallOperations {
      * @public
      */
     startScreenShare(): Promise<void>;
+    /**
+     * Raise hand for current user
+     *
+     * @public
+     */
+    raiseHand(): Promise<void>;
+    /**
+     * lower hand for current user
+     *
+     * @public
+     */
+    lowerHand(): Promise<void>;
     /**
      * Stop sharing the screen
      *
@@ -1354,6 +1365,10 @@ export declare type CallCompositeIcons = {
     ControlButtonParticipants?: JSX.Element;
     ControlButtonScreenShareStart?: JSX.Element;
     ControlButtonScreenShareStop?: JSX.Element;
+    ControlButtonRaiseHand?: JSX.Element;
+    ControlButtonLowerHand?: JSX.Element;
+    RaiseHandContextualMenuItem?: JSX.Element;
+    LowerHandContextualMenuItem?: JSX.Element;
     ErrorBarCallCameraAccessDenied?: JSX.Element;
     ErrorBarCallCameraAlreadyInUse?: JSX.Element;
     ErrorBarCallLocalVideoFreeze?: JSX.Element;
@@ -1396,6 +1411,10 @@ export declare type CallCompositeIcons = {
     BlurVideoBackground?: JSX.Element;
     RemoveVideoBackgroundEffect?: JSX.Element;
     GalleryOptions?: JSX.Element;
+    SpeakerGalleryLayout?: JSX.Element;
+    FloatingLocalVideoGalleryLayout?: JSX.Element;
+    DefaultGalleryLayout?: JSX.Element;
+    OverflowGalleryTop?: JSX.Element;
 };
 
 /**
@@ -1476,6 +1495,15 @@ export declare type CallCompositeOptions = {
      * @remarks if 'false' the local video tile will not be rendered.
      */
     localVideoTile?: boolean | LocalVideoTileOptions;
+    /**
+     * Options for controlling the starting layout of the composite's video gallery
+     */
+    galleryOptions?: {
+        /**
+         * Layout for the gallery when the call starts
+         */
+        layout?: VideoGalleryLayout;
+    };
 };
 
 /**
@@ -2033,6 +2061,18 @@ export declare interface CallCompositeStrings {
      * Label for the toggle to move the overflow gallery to the top
      */
     moreButtonGalleryPositionToggleLabel?: string;
+    /**
+     * Label for the selection of the speaker layout
+     */
+    moreButtonGallerySpeakerLayoutLabel?: string;
+    /**
+     * Label for the selection of the default (Gallery) layout
+     */
+    moreButtonGalleryDefaultLayoutLabel?: string;
+    /**
+     * Label for the selection of the floatingLocalVideo (Dynamic) layout
+     */
+    moreButtonGalleryFloatingLocalLayoutLabel?: string;
 }
 
 /**
@@ -2470,6 +2510,18 @@ export declare interface CallWithChatAdapterManagement {
      * @public
      */
     stopScreenShare(): Promise<void>;
+    /**
+     * Raise hand for local user.
+     *
+     * @public
+     */
+    raiseHand(): Promise<void>;
+    /**
+     * Lower hand for local user.
+     *
+     * @public
+     */
+    lowerHand(): Promise<void>;
     /**
      * Create the html view for a stream.
      *
@@ -3003,6 +3055,15 @@ export declare type CallWithChatCompositeOptions = {
      * if this is not supplied, the composite will not show a unsupported browser page.
      */
     onEnvironmentInfoTroubleshootingClick?: () => void;
+    /**
+     * Options for controlling the starting layout of the composite's video gallery
+     */
+    galleryOptions?: {
+        /**
+         * Layout for the gallery when the call starts
+         */
+        layout?: VideoGalleryLayout;
+    };
 };
 
 /**
@@ -4260,6 +4321,13 @@ export declare type CommonCallControlOptions = {
      * @defaultValue true
      */
     moreButton?: boolean;
+    /**
+     * Show, Hide or Disable the screen share button during a call.
+     * @defaultValue true
+     */
+    raiseHandButton?: boolean | {
+        disabled: boolean;
+    };
     /**
      * Inject custom buttons in the call controls.
      *
@@ -4297,6 +4365,9 @@ export declare interface CommonCallingHandlers {
     onStopScreenShare: () => Promise<void>;
     onToggleScreenShare: () => Promise<void>;
     onHangUp: (forEveryone?: boolean) => Promise<void>;
+    onRaiseHand: () => Promise<void>;
+    onLowerHand: () => Promise<void>;
+    onToggleRaiseHand: () => Promise<void>;
     onToggleHold: () => Promise<void>;
     onAddParticipant(participant: CommunicationUserIdentifier): Promise<void>;
     onAddParticipant(participant: PhoneNumberIdentifier, options: AddPhoneNumberOptions): Promise<void>;
@@ -5376,6 +5447,8 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     ControlButtonScreenShareStop: JSX.Element;
     ControlButtonRaiseHand: JSX.Element;
     ControlButtonLowerHand: JSX.Element;
+    RaiseHandContextualMenuItem: JSX.Element;
+    LowerHandContextualMenuItem: JSX.Element;
     CancelFileUpload: JSX.Element;
     DownloadFile: JSX.Element;
     DataLossPreventionProhibited: JSX.Element;
@@ -5477,6 +5550,10 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     ControlButtonParticipants: JSX.Element;
     ControlButtonScreenShareStart: JSX.Element;
     ControlButtonScreenShareStop: JSX.Element;
+    ControlButtonRaiseHand: JSX.Element;
+    ControlButtonLowerHand: JSX.Element;
+    RaiseHandContextualMenuItem: JSX.Element;
+    LowerHandContextualMenuItem: JSX.Element;
     ErrorBarCallCameraAccessDenied: JSX.Element;
     ErrorBarCallCameraAlreadyInUse: JSX.Element;
     ErrorBarCallLocalVideoFreeze: JSX.Element;
@@ -5517,6 +5594,10 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     BlurVideoBackground?: JSX.Element | undefined;
     RemoveVideoBackgroundEffect?: JSX.Element | undefined;
     GalleryOptions?: JSX.Element | undefined;
+    SpeakerGalleryLayout?: JSX.Element | undefined;
+    FloatingLocalVideoGalleryLayout?: JSX.Element | undefined;
+    DefaultGalleryLayout?: JSX.Element | undefined;
+    OverflowGalleryTop?: JSX.Element | undefined;
     ChevronLeft?: JSX.Element | undefined;
     ControlBarChatButtonActive?: JSX.Element | undefined;
     ControlBarChatButtonInactive?: JSX.Element | undefined;
@@ -5528,8 +5609,6 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     MoreDrawerSpeakers?: JSX.Element | undefined;
     ChatMessageOptions: JSX.Element;
     ControlButtonParticipantsContextualMenuItem: JSX.Element;
-    ControlButtonRaiseHand: JSX.Element;
-    ControlButtonLowerHand: JSX.Element;
     CancelFileUpload: JSX.Element;
     DownloadFile: JSX.Element;
     DataLossPreventionProhibited: JSX.Element;
@@ -8184,9 +8263,27 @@ export declare type Profile = {
  * @public
  */
 export declare type RaisedHand = {
-    order: number;
+    raisedHandOrderPosition: number;
+};
+
+/**
+ * Raised hand state with order
+ *
+ * @public
+ */
+export declare type RaisedHandState = {
+    raisedHandOrderPosition: number;
 };
 
+/**
+ * A button to start / stop screen sharing.
+ *
+ * Can be used with {@link ControlBar}.
+ *
+ * @public
+ */
+export declare const RaiseHandButton: (props: RaiseHandButtonProps) => JSX.Element;
+
 /**
  * Props for {@link RaiseHandButton}.
  *
@@ -8204,6 +8301,16 @@ export declare interface RaiseHandButtonProps extends ControlBarButtonProps {
     strings?: Partial<RaiseHandButtonStrings>;
 }
 
+/**
+ * Selector type for {@link RaiseHandButton} component.
+ *
+ * @public
+ */
+export declare type RaiseHandButtonSelector = (state: CallClientState, props: CallingBaseSelectorProps) => {
+    checked?: boolean;
+    disabled?: boolean;
+};
+
 /**
  * Strings of {@link RaiseHandButton} that can be overridden.
  *
@@ -8232,11 +8339,11 @@ export declare interface RaiseHandCallFeature {
     /**
      * Proxy of {@link @azure/communication-calling#RaiseHandCallFeature.raisedHands}.
      */
-    raisedHands: RaisedHand_2[];
+    raisedHands: RaisedHandState[];
     /**
      * Contains information for local participant from list {@link @azure/communication-calling#RaiseHandCallFeature.raisedHands}.
      */
-    localParticipantRaisedHand?: RaisedHand_2;
+    localParticipantRaisedHand?: RaisedHandState;
 }
 
 /**
@@ -8309,7 +8416,7 @@ export declare interface RemoteParticipantState {
     /**
      * Proxy of {@link @azure/communication-calling#Call.RaisedHand.raisedHands}.
      */
-    raisedHand?: RaisedHand_2;
+    raisedHand?: RaisedHandState;
 }
 
 /**
@@ -9624,7 +9731,7 @@ export declare const VideoGallery: (props: VideoGalleryProps) => JSX.Element;
 /**
  * @public
  */
-export declare type VideoGalleryLayout = 'default' | 'floatingLocalVideo';
+export declare type VideoGalleryLayout = 'default' | 'floatingLocalVideo' | /* @conditional-compile-remove(gallery-layouts) */ 'speaker';
 
 /**
  * The state of the local participant in the {@link VideoGallery}.