CallWithChatAdapterManagement interface

禁止对指定的 User ID 进行音频作。

forbidAudio: (userIds: string[]) => Promise<void>

属性值

禁止 Teams 会议与会者（本地用户除外）使用音频。

forbidOthersAudio: () => Promise<void>

属性值

禁止 Teams 会议与会者（本地用户除外）观看视频。

forbidOthersVideo: () => Promise<void>

属性值

禁止指定 User ID 的视频。

forbidVideo: (userIds: string[]) => Promise<void>

属性值

允许指定 User ID 的音频。

permitAudio: (userIds: string[]) => Promise<void>

属性值

允许 Teams 会议与会者（本地用户除外）使用音频。

permitOthersAudio: () => Promise<void>

属性值

允许 Teams 会议与会者（本地用户除外）观看视频。

permitOthersVideo: () => Promise<void>

属性值

允许指定用户 ID 的视频。

permitVideo: (userIds: string[]) => Promise<void>

属性值

在 1 对 1 通话中向呼叫中的其他参与者发送 DTMF 音调

public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>

属性值

发送实时文本

sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>

属性值

function addParticipant(participant: CommunicationUserIdentifier): Promise<void>

参数

返回

将新参与者添加到呼叫中。

function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>

参数

返回

请求设备的权限。

function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>

参数

返回

注解

如果尚未授予权限，浏览器权限窗口将弹出。

为流创建 html 视图。

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

参数

返回

注解

此方法是针对复合实现的。

为 togethermode 流创建 html 视图。

function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>

参数

返回

注解

此方法是针对复合实现的

删除线程中的消息。

function deleteMessage(messageId: string): Promise<void>

参数

返回

释放本地视频流的 html 视图

function disposeLocalVideoStreamView(): Promise<void>

返回

释放远端视频流的 html 视图

function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>

参数

返回

释放屏幕共享流的 html 视图

function disposeScreenShareStreamView(remoteUserId: string): Promise<void>

参数

返回

注解

该方法为 composite 实现

释放流的 html 视图。

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

参数

返回

注解

此方法是针对复合实现的。

释放 togethermode 流的 html 视图。

function disposeTogetherModeStreamView(): Promise<void>

返回

注解

此方法是针对复合实现的

function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>

参数

返回

提取聊天适配器的初始状态。

执行 ChatComposite 和 API 方法所需的最小提取。

function fetchInitialData(): Promise<void>

返回

将呼叫置于本地保留中。

function holdCall(): Promise<void>

返回

最初打开/关闭麦克风加入呼叫。

function joinCall(microphoneOn?: boolean): undefined | Call

参数

返回

使用选项包加入通话，在加入通话时设置麦克风/摄像头初始状态 true = 加入通话时打开设备 false = 加入通话时关闭设备 'keep'/undefined = 保留设备的通话前状态

function joinCall(options?: JoinCallOptions): undefined | Call

参数

返回

离开呼叫。

function leaveCall(forEveryone?: boolean): Promise<void>

参数

返回

在聊天线程历史记录中加载更多以前的消息。

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

参数

返回

注解

此方法通常用于控制增量提取/无限滚动。

本地用户放低手。

function lowerHand(): Promise<void>

返回

在呼叫期间将当前用户静音或在本地禁用麦克风。

function mute(): Promise<void>

返回

将参与者静音

function muteAllRemoteParticipants(): Promise<void>

返回

将参与者静音

function muteParticipant(userId: string): Promise<void>

参数

返回

将回应发送到正在进行的会议。

function onReactionClick(reaction: Reaction): Promise<void>

参数

返回

查询可用的相机设备。

function queryCameras(): Promise<VideoDeviceInfo[]>

返回

视频设备信息实体数组 <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

注解

应在 askDevicePermission（） 后调用此方法

查询可用的麦克风设备。

function queryMicrophones(): Promise<AudioDeviceInfo[]>

返回

音频设备信息实体数组 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

注解

应在 askDevicePermission（） 后调用此方法

查询可用的麦克风设备。

function querySpeakers(): Promise<AudioDeviceInfo[]>

返回

音频设备信息实体数组 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

注解

应在 askDevicePermission（） 后调用此方法

向本地用户举手。

function raiseHand(): Promise<void>

返回

从呼叫中删除参与者。

function removeParticipant(participant: CommunicationIdentifier): Promise<void>

参数

返回

从呼叫中删除参与者。

function removeParticipant(userId: string): Promise<void>

参数

返回

function removeResourceFromCache(resourceDetails: ResourceDetails)

参数

从 LocalHold 状态恢复调用。

function resumeCall(): Promise<void>

返回

返回分组讨论室的源站呼叫

function returnFromBreakoutRoom(): Promise<void>

返回

在线程中发送消息。

function sendMessage(content: string, options?: SendMessageOptions): Promise<void>

参数

返回

发送邮件的已读回执。

function sendReadReceipt(chatMessageId: string): Promise<void>

参数

返回

在线程中发送键入指示器。

function sendTypingIndicator(): Promise<void>

返回

将相机设置为在呼叫中使用。

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

参数

返回

设置字幕语言的功能

function setCaptionLanguage(language: string): Promise<void>

参数

返回

将麦克风设置为在呼叫中使用。

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

参数

返回

将扬声器设置为在呼叫中使用。

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

参数

返回

设置口语的功能

function setSpokenLanguage(language: string): Promise<void>

参数

返回

重新计算 Together 模式的座位位置。

function setTogetherModeSceneSize(width: number, height: number)

参数

注解

此方法是针对复合实现的

启动呼叫。

function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call

参数

返回

启动呼叫。

function startCall(participants: string[], options?: StartCallOptions): undefined | Call

参数

返回

启动相机。

此方法将在调用未处于活动状态时开始呈现本地相机视图。

function startCamera(options?: VideoStreamOptions): Promise<void>

参数

返回

启动字幕的功能

function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>

参数

返回

启动噪声抑制效果。

function startNoiseSuppressionEffect(): Promise<void>

返回

开始在通话期间共享屏幕。

function startScreenShare(): Promise<void>

返回

启动 spotlight

function startSpotlight(userIds?: string[]): Promise<void>

参数

返回

一起启动模式。

function startTogetherMode(): Promise<void>

返回

注解

此方法是针对复合实现的

启动视频背景效果。

function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>

参数

返回

停止所有聚光灯

function stopAllSpotlight(): Promise<void>

返回

停止相机。

当调用未处于活动状态时，此方法将停止呈现本地相机视图。

function stopCamera(): Promise<void>

返回

停止字幕的功能

function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>

参数

返回

启动噪声抑制效果。

function stopNoiseSuppressionEffect(): Promise<void>

返回

停止共享屏幕。

function stopScreenShare(): Promise<void>

返回

停止聚光灯

function stopSpotlight(userIds?: string[]): Promise<void>

参数

返回

停止视频背景效果。

function stopVideoBackgroundEffects(): Promise<void>

返回

发送通话结束调查结果

function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>

参数

返回

在呼叫期间取消静音当前用户或在本地启用麦克风。

function unmute(): Promise<void>

返回

覆盖背景选取器图像以获得背景替换效果。

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

参数

更新消息内容。

function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>

参数

返回

更新选定的视频背景效果

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

参数