@azure/communication-react 1.4.2-alpha-202211150040.0 → 1.4.2-alpha-202211170015.0

package/dist/communication-react.d.ts

@@ -52,6 +52,7 @@ import { IContextualMenuItemStyles } from '@fluentui/react';
 import { IContextualMenuStyles } from '@fluentui/react';
 import { IDropdownOption } from '@fluentui/react';
 import { IDropdownStyles } from '@fluentui/react';
+import { IIconProps } from '@fluentui/react';
 import { ILinkStyles } from '@fluentui/react';
 import { IMessageBarProps } from '@fluentui/react';
 import { IncomingCall } from '@azure/communication-calling';
@@ -83,6 +84,8 @@ import { RoomCallLocator } from '@azure/communication-calling';
 import { ScalingMode } from '@azure/communication-calling';
 import { SendMessageOptions } from '@azure/communication-chat';
 import { StartCallOptions } from '@azure/communication-calling';
+import { TeamsCall } from '@azure/communication-calling';
+import { TeamsCallAgent } from '@azure/communication-calling';
 import { TeamsMeetingLinkLocator } from '@azure/communication-calling';
 import { Theme } from '@fluentui/react';
 import { TypingIndicatorReceivedEvent } from '@azure/communication-chat';
@@ -263,14 +266,21 @@ export declare type AzureCommunicationCallAdapterArgs = {
     /**
      * Optional parameters for the {@link AzureCommunicationCallAdapter} created
      */
-    options?: {
-        /**
-         * Use this to hint the role of the user when the role is not available before a Rooms call is started. This value
-         * should be obtained using the Rooms API. This role will determine permissions in the configuration page of the
-         * {@link CallComposite}. The true role of the user will be synced with ACS services when a Rooms call starts.
-         */
-        roleHint?: Role;
-    };
+    options?: AzureCommunicationCallAdapterOptions;
+};
+
+/**
+ * Optional parameters to create {@link AzureCommunicationCallAdapter}
+ *
+ * @beta
+ */
+export declare type AzureCommunicationCallAdapterOptions = {
+    /**
+     * Use this to hint the role of the user when the role is not available before a Rooms call is started. This value
+     * should be obtained using the Rooms API. This role will determine permissions in the configuration page of the
+     * {@link CallComposite}. The true role of the user will be synced with ACS services when a Rooms call starts.
+     */
+    roleHint?: Role;
 };
 
 /**
@@ -919,7 +929,7 @@ export declare const CallAgentProvider: (props: CallAgentProviderProps) => JSX.E
  */
 export declare interface CallAgentProviderProps {
     children: React_2.ReactNode;
-    callAgent?: CallAgent;
+    callAgent?: CallAgent | /* @conditional-compile-remove(teams-identity-support) */ TeamsCallAgent;
 }
 
 /**
@@ -1679,30 +1689,9 @@ export declare type CallingBaseSelectorProps = {
  *
  * @public
  */
-export declare type CallingHandlers = {
-    onStartLocalVideo: () => Promise<void>;
-    onToggleCamera: (options?: VideoStreamOptions) => Promise<void>;
-    onStartCall: (participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | UnknownIdentifier)[], options?: StartCallOptions) => Call | undefined;
-    onSelectMicrophone: (device: AudioDeviceInfo) => Promise<void>;
-    onSelectSpeaker: (device: AudioDeviceInfo) => Promise<void>;
-    onSelectCamera: (device: VideoDeviceInfo, options?: VideoStreamOptions) => Promise<void>;
-    onToggleMicrophone: () => Promise<void>;
-    onStartScreenShare: () => Promise<void>;
-    onStopScreenShare: () => Promise<void>;
-    onToggleScreenShare: () => Promise<void>;
-    onHangUp: (forEveryone?: boolean) => Promise<void>;
-    onToggleHold: () => Promise<void>;
-    onAddParticipant(participant: CommunicationUserIdentifier): Promise<void>;
-    onAddParticipant(participant: PhoneNumberIdentifier, options: AddPhoneNumberOptions): Promise<void>;
-    onCreateLocalStreamView: (options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>;
-    onCreateRemoteStreamView: (userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>;
-    onRemoveParticipant(userId: string): Promise<void>;
-    onRemoveParticipant(participant: CommunicationIdentifier): Promise<void>;
-    onDisposeRemoteStreamView: (userId: string) => Promise<void>;
-    onDisposeLocalStreamView: () => Promise<void>;
-    onSendDtmfTone: (dtmfTone: DtmfTone_2) => Promise<void>;
-    askDevicePermission: (constrain: PermissionConstraints) => Promise<void>;
-};
+export declare interface CallingHandlers extends CommonCallingHandlers {
+    onStartCall: (participants: CommunicationIdentifier[], options?: StartCallOptions) => Call | undefined;
+}
 
 /**
  * Helper type for {@link usePropsFor}.
@@ -1776,7 +1765,7 @@ export declare const CallProvider: (props: CallProviderProps) => JSX.Element;
  */
 export declare interface CallProviderProps {
     children: React_2.ReactNode;
-    call?: Call;
+    call?: Call | /* @conditional-compile-remove(teams-identity-support) */ TeamsCall;
 }
 
 /**
@@ -3410,6 +3399,39 @@ export declare type ClientState = CallClientState & ChatClientState;
  */
 export declare type Common<A, B> = Pick<A, CommonProperties<A, B>>;
 
+/**
+ * Object containing all the handlers required for calling components.
+ *
+ * Calling related components from this package are able to pick out relevant handlers from this object.
+ * See {@link useHandlers} and {@link usePropsFor}.
+ *
+ * @public
+ */
+export declare interface CommonCallingHandlers {
+    onStartLocalVideo: () => Promise<void>;
+    onToggleCamera: (options?: VideoStreamOptions) => Promise<void>;
+    onSelectMicrophone: (device: AudioDeviceInfo) => Promise<void>;
+    onSelectSpeaker: (device: AudioDeviceInfo) => Promise<void>;
+    onSelectCamera: (device: VideoDeviceInfo, options?: VideoStreamOptions) => Promise<void>;
+    onToggleMicrophone: () => Promise<void>;
+    onStartScreenShare: () => Promise<void>;
+    onStopScreenShare: () => Promise<void>;
+    onToggleScreenShare: () => Promise<void>;
+    onHangUp: (forEveryone?: boolean) => Promise<void>;
+    onToggleHold: () => Promise<void>;
+    onAddParticipant(participant: CommunicationUserIdentifier): Promise<void>;
+    onAddParticipant(participant: PhoneNumberIdentifier, options: AddPhoneNumberOptions): Promise<void>;
+    onCreateLocalStreamView: (options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>;
+    onCreateRemoteStreamView: (userId: string, options?: VideoStreamOptions) => Promise<void | CreateVideoStreamViewResult>;
+    onDisposeRemoteStreamView: (userId: string) => Promise<void>;
+    onDisposeLocalStreamView: () => Promise<void>;
+    onSendDtmfTone: (dtmfTone: DtmfTone_2) => Promise<void>;
+    onRemoveParticipant(userId: string): Promise<void>;
+    onRemoveParticipant(participant: CommunicationIdentifier): Promise<void>;
+    askDevicePermission: (constrain: PermissionConstraints) => Promise<void>;
+    onStartCall: (participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | UnknownIdentifier)[], options?: StartCallOptions) => void;
+}
+
 /**
  * @beta
  * Props for DomainPermissions components.
@@ -4010,7 +4032,7 @@ export declare const createAzureCommunicationChatAdapter: ({ endpoint: endpointU
 export declare const createAzureCommunicationChatAdapterFromClient: (chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient) => Promise<ChatAdapter>;
 
 /**
- * Create the default implementation of {@link CallingHandlers}.
+ * Create the default implementation of {@link CallingHandlers} for teams call.
  *
  * Useful when implementing a custom component that utilizes the providers
  * exported from this library.
@@ -4031,6 +4053,16 @@ export declare const createDefaultCallingHandlers: (callClient: StatefulCallClie
  */
 export declare const createDefaultChatHandlers: (chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient) => ChatHandlers;
 
+/**
+ * Create the default implementation of {@link TeamsCallingHandlers} for teams call.
+ *
+ * Useful when implementing a custom component that utilizes the providers
+ * exported from this library.
+ *
+ * @beta
+ */
+export declare const createDefaultTeamsCallingHandlers: (callClient: StatefulCallClient, callAgent: undefined | /* @conditional-compile-remove(teams-identity-support) */ TeamsCallAgent, deviceManager: StatefulDeviceManager | undefined, call: undefined | /* @conditional-compile-remove(teams-identity-support) */ TeamsCall) => never | TeamsCallingHandlers;
+
 /**
  * Creates a StatefulCallClient {@link StatefulCallClient} by proxying CallClient
  * {@link @azure/communication-calling#CallClient} with ProxyCallClient {@link ProxyCallClient} which then allows access
@@ -4357,6 +4389,7 @@ export declare const DEFAULT_COMPONENT_ICONS: {
     DomainPermissionMicDenied: JSX.Element;
     UnsupportedBrowserWarning: JSX.Element;
     BrowserPermissionDeniedError: JSX.Element;
+    VideoTilePinned: JSX.Element;
 };
 
 /**
@@ -4452,6 +4485,7 @@ export declare const DEFAULT_COMPOSITE_ICONS: {
     DomainPermissionMicDenied: JSX.Element;
     UnsupportedBrowserWarning: JSX.Element;
     BrowserPermissionDeniedError: JSX.Element;
+    VideoTilePinned: JSX.Element;
 };
 
 /**
@@ -7410,6 +7444,18 @@ export declare interface SystemMessageCommon extends MessageCommon {
     iconName: string;
 }
 
+/**
+ * Object containing all the teams call handlers required for calling components.
+ *
+ * Calling related components from this package are able to pick out relevant handlers from this object.
+ * See {@link useHandlers} and {@link usePropsFor}.
+ *
+ * @beta
+ */
+export declare interface TeamsCallingHandlers extends CommonCallingHandlers {
+    onStartCall: (participants: CommunicationIdentifier[], options?: StartCallOptions) => undefined | /* @conditional-compile-remove(teams-identity-support) */ TeamsCall;
+}
+
 /**
  * A string representation of a {@link @azure/communication-common#CommunicationIdentifier}.
  *
@@ -7684,6 +7730,8 @@ export declare const useAzureCommunicationChatAdapter: (args: Partial<AzureCommu
  * Useful when implementing a custom component that utilizes the providers
  * exported from this library.
  *
+ * you must have previously used the CallProvider with a Call object to use this hook
+ *
  * @public
  */
 export declare const useCall: () => Call | undefined;
@@ -7774,6 +7822,28 @@ export declare const usePropsFor: <Component extends (props: any) => JSX.Element
  */
 export declare const useSelector: <ParamT extends Selector | undefined>(selector: ParamT, selectorProps?: (ParamT extends Selector ? Parameters<ParamT>[1] : undefined) | undefined, type?: "chat" | "calling" | undefined) => ParamT extends Selector ? ReturnType<ParamT> : undefined;
 
+/**
+ * Hook to obtain {@link @azure/communication-calling#TeamsCall} from the provider.
+ *
+ * Useful when implementing a custom component that utilizes the providers
+ * exported from this library.
+ *
+ * you must have previously used the CallProvider with a TeamsCall object to use this hook
+ *
+ * @beta
+ */
+export declare const useTeamsCall: () => undefined | /* @conditional-compile-remove(teams-identity-support) */ TeamsCall;
+
+/**
+ * Hook to obtain {@link @azure/communication-calling#TeamsCallAgent} from the provider.
+ *
+ * Useful when implementing a custom component that utilizes the providers
+ * exported from this library.
+ *
+ * @beta
+ */
+export declare const useTeamsCallAgent: () => undefined | /* @conditional-compile-remove(teams-identity-support) */ TeamsCallAgent;
+
 /**
  * React hook to access theme
  *
@@ -8006,6 +8076,18 @@ export declare interface VideoStreamRendererViewState {
  */
 export declare const VideoTile: (props: VideoTileProps) => JSX.Element;
 
+/**
+ * @beta
+ * MenuItems to be diplayed in video tile in the contextual/drawer menu
+ */
+export declare type VideoTileMenuItems = Array<{
+    key: string;
+    ariaLabel?: string;
+    text: string;
+    onClick: () => void;
+    iconProps: IIconProps;
+}>;
+
 /**
  * Props for {@link VideoTile}.
  *
@@ -8044,6 +8126,14 @@ export declare interface VideoTileProps {
      * Whether the video is muted or not.
      */
     isMuted?: boolean;
+    /**
+     * Display custom menu items in the VideoTile's contextual menu.
+     */
+    menuItems?: VideoTileMenuItems;
+    /**
+     * If true, the video tile will show the pin icon.
+     */
+    isPinned?: boolean;
     /**
      * Display Name of the Participant to be shown in the label.
      * @remarks `displayName` is used to generate avatar initials if `initialsName` is not provided.