@azure/communication-react 1.11.1-alpha-202401110013 → 1.11.1-alpha-202401130013

package/dist/communication-react.d.ts

@@ -93,6 +93,7 @@ import { RemoteParticipantState as RemoteParticipantState_2 } from '@azure/commu
 import { RoomCallLocator } from '@azure/communication-calling';
 import { ScalingMode } from '@azure/communication-calling';
 import { SendMessageOptions } from '@azure/communication-chat';
+import { SpotlightedParticipant } from '@azure/communication-calling';
 import { StartCallOptions } from '@azure/communication-calling';
 import { StartCaptionsOptions } from '@azure/communication-calling';
 import { SyntheticEvent } from 'react';
@@ -893,6 +894,18 @@ export declare interface CallAdapterCallOperations {
      * @beta
      */
     submitSurvey(survey: CallSurvey): Promise<CallSurveyResponse | undefined>;
+    /**
+     * Start spotlight
+     *
+     * @beta
+     */
+    startSpotlight(userId: string): Promise<void>;
+    /**
+     * Stop spotlight
+     *
+     * @beta
+     */
+    stopSpotlight(userId: string): Promise<void>;
 }
 
 /**
@@ -1408,6 +1421,7 @@ export declare type CallCompositeIcons = {
     ControlButtonLowerHand?: JSX.Element;
     RaiseHandContextualMenuItem?: JSX.Element;
     LowerHandContextualMenuItem?: JSX.Element;
+    ReactionButtonIcon?: JSX.Element;
     ErrorBarCallCameraAccessDenied?: JSX.Element;
     ErrorBarCallCameraAlreadyInUse?: JSX.Element;
     ErrorBarCallLocalVideoFreeze?: JSX.Element;
@@ -2677,6 +2691,10 @@ export declare interface CallState {
      * Hide attendee names in teams meeting
      */
     hideAttendeeNames?: boolean;
+    /**
+     * Proxy of {@link @azure/communication-calling#SpotlightCallFeature}.
+     */
+    spotlight?: SpotlightCallFeatureState;
 }
 
 /**
@@ -3086,6 +3104,18 @@ export declare interface CallWithChatAdapterManagement {
      * @beta
      */
     submitSurvey(survey: CallSurvey): Promise<CallSurveyResponse | undefined>;
+    /**
+     * Start spotlight
+     *
+     * @beta
+     */
+    startSpotlight(userId: string): Promise<void>;
+    /**
+     * Stop spotlight
+     *
+     * @beta
+     */
+    stopSpotlight(userId: string): Promise<void>;
 }
 
 /**
@@ -4905,6 +4935,8 @@ export declare interface CommonCallingHandlers {
     onSetSpokenLanguage: (language: string) => Promise<void>;
     onSetCaptionLanguage: (language: string) => Promise<void>;
     onSubmitSurvey(survey: CallSurvey): Promise<CallSurveyResponse | undefined>;
+    onStartSpotlight: (userId: string) => Promise<void>;
+    onStopSpotlight: (userId: string) => Promise<void>;
 }
 
 /**
@@ -5171,6 +5203,8 @@ export declare interface ComponentStrings {
     screenShareButton: ScreenShareButtonStrings;
     /** Strings for RaiseHandButton */
     raiseHandButton: RaiseHandButtonStrings;
+    /** Strings for ReactionButton */
+    reactionButton: ReactionButtonStrings;
     /** Strings for TypingIndicator */
     typingIndicator: TypingIndicatorStrings;
     /** Strings for SendBox */
@@ -5947,6 +5981,7 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     ControlButtonLowerHand: React_2.JSX.Element;
     RaiseHandContextualMenuItem: React_2.JSX.Element;
     LowerHandContextualMenuItem: React_2.JSX.Element;
+    ReactionButtonIcon: React_2.JSX.Element;
     CancelFileUpload: React_2.JSX.Element;
     DownloadFile: React_2.JSX.Element;
     DataLossPreventionProhibited: React_2.JSX.Element;
@@ -6057,6 +6092,7 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     ControlButtonLowerHand: JSX.Element;
     RaiseHandContextualMenuItem: JSX.Element;
     LowerHandContextualMenuItem: JSX.Element;
+    ReactionButtonIcon: JSX.Element;
     ErrorBarCallCameraAccessDenied: JSX.Element;
     ErrorBarCallCameraAlreadyInUse: JSX.Element;
     ErrorBarCallLocalVideoFreeze: JSX.Element;
@@ -8973,6 +9009,36 @@ export declare type Reaction = {
     receivedAt: Date;
 };
 
+/**
+ * Props for {@link ReactionButton}.
+ *
+ * @beta
+ */
+export declare interface ReactionButtonProps extends ControlBarButtonProps {
+    /**
+     * Optional strings to override in component
+     */
+    strings?: Partial<ReactionButtonStrings>;
+    /**
+     * Click event to send reaction to meeting
+     */
+    onReactionClicked: (emoji: string) => Promise<void>;
+}
+
+/**
+ * Strings of {@link ReactionButton} that can be overridden.
+ *
+ * @beta
+ */
+export declare interface ReactionButtonStrings {
+    /** Label of the button. */
+    label: string;
+    /** * Tooltip content when the button is disabled. */
+    tooltipDisabledContent?: string;
+    /** Tooltip content when the button is enabled. */
+    tooltipContent?: string;
+}
+
 /**
  * State only version of {@link @azure/communication-calling#Call.ReactionMessage} with UI helper props receivedAt.
  * Reaction state with a timestamp which helps UI to decide to render the reaction accordingly.
@@ -9068,6 +9134,10 @@ export declare interface RemoteParticipantState {
      * @beta
      */
     reactionState?: ReactionState;
+    /**
+     * Proxy of {@link @azure/communication-calling#SpotlightCallFeature.spotlightedParticipants}.
+     */
+    spotlighted?: SpotlightState;
 }
 
 /**
@@ -9448,6 +9518,30 @@ export declare interface SpokenLanguageStrings {
     'zh-tw': string;
 }
 
+/**
+ * State only version of {@link @azure/communication-calling#SpotlightCallFeature}
+ *
+ * @beta
+ */
+export declare interface SpotlightCallFeatureState {
+    /**
+     * Ordered array of spotlighted participants in call
+     */
+    spotlightedParticipants: SpotlightedParticipant[];
+}
+
+/**
+ * Spotlight state with order
+ *
+ * @beta
+ */
+export declare interface SpotlightState {
+    /**
+     * Order position of spotlight in call
+     */
+    spotlightedOrderPosition?: number;
+}
+
 /**
  * Defines the methods that allow CallClient {@link @azure/communication-calling#CallClient} to be used statefully.
  * The interface provides access to proxied state and also allows registering a handler for state change events. For
@@ -10679,6 +10773,7 @@ export declare type VideoGallerySelector = (state: CallClientState, props: Calli
     remoteParticipants: VideoGalleryRemoteParticipant[];
     dominantSpeakers?: string[];
     optimalVideoCount?: number;
+    spotlightedParticipants?: string[];
 };
 
 /**