@azure/communication-react 1.0.0-alpha-20211126.11.0 → 1.0.0-alpha

package/dist/communication-react.d.ts

@@ -227,6 +227,20 @@ export declare type AzureCommunicationChatAdapterArgs = {
     threadId: string;
 };
 
+/**
+ * Arguments for {@link createAzureCommunicationMeetingAdapter}
+ *
+ * @beta
+ */
+export declare type AzureCommunicationMeetingAdapterArgs = {
+    endpoint: string;
+    userId: CommunicationUserIdentifier;
+    displayName: string;
+    credential: CommunicationTokenCredential;
+    chatThreadId: string;
+    callLocator: TeamsMeetingLinkLocator | GroupCallLocator;
+};
+
 /**
  * Properties common to all composites exported from this library.
  *
@@ -1299,7 +1313,7 @@ export declare interface CameraButtonProps extends ControlBarButtonProps {
     /**
      * Options for rendering local video view.
      */
-    localVideoViewOption?: VideoStreamOptions;
+    localVideoViewOptions?: VideoStreamOptions;
     /**
      * Optional strings to override in component
      */
@@ -1326,6 +1340,8 @@ export declare interface CameraButtonStrings {
     onLabel: string;
     /** Label when button is off. */
     offLabel: string;
+    /** Tooltip content when the button is disabled. */
+    tooltipDisabledContent?: string;
     /** Tooltip content when the button is on. */
     tooltipOnContent?: string;
     /** Tooltip content when the button is off. */
@@ -1571,6 +1587,13 @@ export declare type ChatCompositeOptions = {
      * @defaultValue true
      */
     errorBar?: boolean;
+    /**
+     * Show or hide the participant pane. This feature is in beta and not supported on mobile or narrow screen views.
+     * @defaultValue false
+     *
+     * @beta
+     */
+    participantPane?: boolean;
     /**
      * Show or hide the topic at the top of the chat. Hidden if set to `false`
      * @defaultValue true
@@ -2257,9 +2280,13 @@ export declare interface ControlBarButtonStrings {
      */
     offLabel?: string;
     /**
-     * Tooltip content of the button. This supersedes tooltipOnContent and tooltipOffContent if used.
+     * Tooltip content of the button. This supersedes tooltipDisabledContent, tooltipOnContent and tooltipOffContent if used.
      */
     tooltipContent?: string;
+    /**
+     * Tooltip content when the button is disabled.
+     */
+    tooltipDisabledContent?: string;
     /**
      * Tooltip content when the button is in the checked state.
      */
@@ -2348,6 +2375,14 @@ export declare const createAzureCommunicationChatAdapter: ({ endpoint: endpointU
  */
 export declare const createAzureCommunicationChatAdapterFromClient: (chatClient: StatefulChatClient, chatThreadClient: ChatThreadClient) => Promise<ChatAdapter>;
 
+/**
+ * Create a meeting adapter backed by Azure Communication services
+ * to plug into the Meeting Composite.
+ *
+ * @beta
+ */
+export declare const createAzureCommunicationMeetingAdapter: ({ userId, displayName, credential, endpoint, chatThreadId, callLocator }: AzureCommunicationMeetingAdapterArgs) => Promise<MeetingAdapter>;
+
 /**
  * Create the default implementation of {@link CallingHandlers}.
  *
@@ -3301,6 +3336,191 @@ export declare interface MediaDiagnosticsState {
     latest: LatestMediaDiagnostics;
 }
 
+/**
+ * Meeting Composite Adapter interface.
+ * @beta
+ */
+export declare interface MeetingAdapter extends MeetingAdapterMeetingManagement, AdapterState<MeetingAdapterState>, Disposable, MeetingAdapterSubscriptions {
+}
+
+/**
+ * State from the backend services that drives Meeting Composite.
+ *
+ * @beta
+ */
+export declare interface MeetingAdapterClientState extends Pick<CallAdapterClientState, 'devices' | 'isTeamsCall'> {
+    /** ID of the meeting participant using this Meeting Adapter. */
+    userId: CommunicationIdentifierKind;
+    /** Display name of the meeting participant using this Meeting Adapter. */
+    displayName: string | undefined;
+    /** State of the current Meeting. */
+    meeting: MeetingState | undefined;
+}
+
+/**
+ * Functionality for managing the current meeting.
+ * @beta
+ */
+export declare interface MeetingAdapterMeetingManagement extends Pick<CallAdapterCallManagement, 'startCamera' | 'stopCamera' | 'mute' | 'unmute' | 'startScreenShare' | 'stopScreenShare' | 'createStreamView' | 'disposeStreamView'>, Pick<CallAdapterDeviceManagement, 'setCamera' | 'setMicrophone' | 'setSpeaker' | 'askDevicePermission' | 'queryCameras' | 'queryMicrophones' | 'querySpeakers'>, Pick<ChatAdapterThreadManagement, 'fetchInitialData' | 'sendMessage' | 'sendReadReceipt' | 'sendTypingIndicator' | 'loadPreviousChatMessages' | 'updateMessage' | 'deleteMessage'> {
+    /**
+     * Join an existing Meeting
+     * @returns The underlying Call object of the meeting.
+     */
+    joinMeeting(microphoneOn?: boolean): Call | undefined;
+    /**
+     * Leave the current Meeting
+     */
+    leaveMeeting(): Promise<void>;
+    /**
+     * Start a new Meeting
+     * @param participants - Array of participant IDs. These represent the participants to initialize the meeting with.
+     * @returns The underlying Call object of the meeting.
+     */
+    startMeeting(participants: string[]): Call | undefined;
+    /**
+     * Remove a participant from a Meeting
+     * @param userId - UserId of the participant to remove.
+     */
+    removeParticipant(userId: string): Promise<void>;
+}
+
+/**
+ * Meeting State is a combination of Stateful Chat and Stateful Calling clients with some
+ * state specific to meetings only.
+ * Stateful items like Participants that apply to both calling and chat are intelligently
+ * combined into one to suit the purpose of a Meeting.
+ *
+ * @beta
+ */
+export declare interface MeetingAdapterState extends MeetingAdapterUiState, MeetingAdapterClientState {
+}
+
+/**
+ * Meeting events that can be subscribed to.
+ * @beta
+ */
+export declare interface MeetingAdapterSubscriptions {
+    on(event: 'participantsJoined', listener: ParticipantsJoinedListener): void;
+    on(event: 'participantsLeft', listener: ParticipantsLeftListener): void;
+    on(event: 'meetingEnded', listener: CallEndedListener): void;
+    on(event: 'error', listener: (e: Error) => void): void;
+    off(event: 'participantsJoined', listener: ParticipantsJoinedListener): void;
+    off(event: 'participantsLeft', listener: ParticipantsLeftListener): void;
+    off(event: 'meetingEnded', listener: CallEndedListener): void;
+    off(event: 'error', listener: (e: Error) => void): void;
+    on(event: 'isMutedChanged', listener: IsMutedChangedListener): void;
+    on(event: 'callIdChanged', listener: CallIdChangedListener): void;
+    on(event: 'isLocalScreenSharingActiveChanged', listener: IsLocalScreenSharingActiveChangedListener): void;
+    on(event: 'displayNameChanged', listener: DisplayNameChangedListener): void;
+    on(event: 'isSpeakingChanged', listener: IsSpeakingChangedListener): void;
+    off(event: 'isMutedChanged', listener: IsMutedChangedListener): void;
+    off(event: 'callIdChanged', listener: CallIdChangedListener): void;
+    off(event: 'isLocalScreenSharingActiveChanged', listener: IsLocalScreenSharingActiveChangedListener): void;
+    off(event: 'displayNameChanged', listener: DisplayNameChangedListener): void;
+    off(event: 'isSpeakingChanged', listener: IsSpeakingChangedListener): void;
+    on(event: 'messageReceived', listener: MessageReceivedListener): void;
+    on(event: 'messageSent', listener: MessageSentListener): void;
+    on(event: 'messageRead', listener: MessageReadListener): void;
+    off(event: 'messageReceived', listener: MessageReceivedListener): void;
+    off(event: 'messageSent', listener: MessageSentListener): void;
+    off(event: 'messageRead', listener: MessageReadListener): void;
+}
+
+/**
+ * UI state pertaining to the Meeting Composite.
+ *
+ * @beta
+ */
+export declare interface MeetingAdapterUiState extends Pick<CallAdapterUiState, 'isLocalPreviewMicrophoneEnabled'> {
+    /** Current page in the meeting composite. */
+    page: MeetingCompositePage;
+}
+
+/**
+ * Meeting Composite brings together key components to provide a full meeting experience out of the box.
+ *
+ * @beta
+ */
+export declare const MeetingComposite: (props: MeetingCompositeProps) => JSX.Element;
+
+/**
+ * Page state the Meeting composite could be in.
+ *
+ * @beta
+ */
+export declare type MeetingCompositePage = 'accessDeniedTeamsMeeting' | 'configuration' | 'joinMeetingFailedDueToNoNetwork' | 'leftMeeting' | 'lobby' | 'meeting' | 'removedFromMeeting';
+
+/**
+ * Props required for the {@link MeetingComposite}
+ *
+ * @beta
+ */
+export declare interface MeetingCompositeProps extends BaseCompositeProps<CallCompositeIcons & ChatCompositeIcons> {
+    meetingAdapter: MeetingAdapter;
+    /**
+     * Fluent theme for the composite.
+     *
+     * Defaults to a light theme if undefined.
+     */
+    fluentTheme?: PartialTheme | Theme;
+    /**
+     * Optimizes the composite form factor for either desktop or mobile.
+     * @remarks `mobile` is currently only optimized for Portrait mode on mobile devices and does not support landscape.
+     * @defaultValue 'desktop'
+     * @beta
+     */
+    formFactor?: 'desktop' | 'mobile';
+    /**
+     * URL that can be used to copy a meeting invite to the Users clipboard.
+     */
+    meetingInvitationURL?: string;
+}
+
+/**
+ * Describes the reason the meeting ended.
+ *
+ * @beta
+ */
+export declare type MeetingEndReason = CallEndReason;
+
+/**
+ * Events fired off by the Meeting Adapter
+ * @beta
+ */
+export declare type MeetingEvent = 'participantsJoined' | 'participantsLeft' | 'meetingEnded' | 'isMutedChanged' | 'callIdChanged' | 'isLocalScreenSharingActiveChanged' | 'displayNameChanged' | 'isSpeakingChanged' | 'messageReceived' | 'messageSent' | 'messageRead' | 'error';
+
+/**
+ * Participants of a Meeting.
+ *
+ * @beta
+ */
+export declare interface MeetingParticipant extends Pick<RemoteParticipantState, 'displayName' | 'state' | 'videoStreams' | 'isMuted' | 'isSpeaking'> {
+    /** ID of the meeting participant. */
+    id: CommunicationUserKind | PhoneNumberKind | MicrosoftTeamsUserKind | UnknownIdentifierKind;
+    /** Describes the reason the meeting ended for this participant. */
+    meetingEndReason?: MeetingEndReason;
+}
+
+/**
+ * State of a single Meeting.
+ *
+ * @beta
+ */
+export declare interface MeetingState extends Pick<CallState, 'callerInfo' | 'state' | 'isMuted' | 'isScreenSharingOn' | 'localVideoStreams' | 'transcription' | 'recording' | 'screenShareRemoteParticipant' | 'startTime' | 'endTime' | 'diagnostics' | 'dominantSpeakers'>, Pick<ChatThreadClientState, 'chatMessages' | 'threadId' | 'properties' | 'readReceipts' | 'typingIndicators' | 'latestReadTime'> {
+    /** Current Meeting ID. */
+    id: string;
+    /** Active participants in the current meeting. */
+    participants: {
+        [key: string]: MeetingParticipant;
+    };
+    /** Participants who have left the current meeting. */
+    participantsEnded: {
+        [keys: string]: MeetingParticipant;
+    };
+    /** Reason the current meeting has ended. */
+    meetingEndReason?: MeetingEndReason;
+}
+
 /**
  * Discriminated union of all messages.
  *
@@ -3736,6 +3956,8 @@ export declare interface MicrophoneButtonStrings {
     onLabel: string;
     /** Label when button is off. */
     offLabel: string;
+    /** * Tooltip content when the button is disabled. */
+    tooltipDisabledContent?: string;
     /** Tooltip content when the button is on. */
     tooltipOnContent?: string;
     /** Tooltip content when the button is off. */
@@ -4275,6 +4497,8 @@ export declare interface ScreenShareButtonStrings {
     onLabel: string;
     /** Label when button is off. */
     offLabel: string;
+    /** * Tooltip content when the button is disabled. */
+    tooltipDisabledContent?: string;
     /** Tooltip content when the button is on. */
     tooltipOnContent?: string;
     /** Tooltip content when the button is off. */
@@ -4983,9 +5207,9 @@ export declare interface VideoGalleryProps {
     /** List of dominant speaker userIds in the order of their dominance. 0th index is the most dominant. */
     dominantSpeakers?: string[];
     /** Local video view options */
-    localVideoViewOption?: VideoStreamOptions;
+    localVideoViewOptions?: VideoStreamOptions;
     /** Remote videos view options */
-    remoteVideoViewOption?: VideoStreamOptions;
+    remoteVideoViewOptions?: VideoStreamOptions;
     /** Callback to create the local video stream view */
     onCreateLocalStreamView?: (options?: VideoStreamOptions) => Promise<void>;
     /** Callback to dispose of the local video stream view */
@@ -4996,6 +5220,7 @@ export declare interface VideoGalleryProps {
     onCreateRemoteStreamView?: (userId: string, options?: VideoStreamOptions) => Promise<void>;
     /** Callback to render a remote video tile */
     onRenderRemoteVideoTile?: (remoteParticipant: VideoGalleryRemoteParticipant) => JSX.Element;
+    /** Callback to dispose a remote video stream view */
     onDisposeRemoteStreamView?: (userId: string) => Promise<void>;
     /** Callback to render a particpant avatar */
     onRenderAvatar?: OnRenderAvatarCallback;