你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CallAdapterCallManagement interface

包:: @azure/communication-react

警告

现已弃用此 API。

CallAdapter interface will be flatten, consider using CallAdapter directly

用于管理当前呼叫或启动新呼叫的功能

扩展: CallAdapterCallOperations

继承属性

sendRealTimeText

发送实时文本

方法

joinCall(boolean)	最初打开/关闭麦克风加入呼叫。
joinCall(JoinCallOptions)	使用选项包加入通话，在加入通话时设置麦克风/摄像头初始状态 true = 加入通话时打开设备 false = 加入通话时关闭设备 'keep'/undefined = 保留设备的通话前状态
startCall(CommunicationIdentifier[], StartCallOptions)	启动呼叫。
startCall(string[], StartCallOptions)	启动呼叫。

继承的方法

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	将参与者添加到呼叫。
createStreamView(string, VideoStreamOptions)	为流创建 html 视图。
createTogetherModeStreamView(TogetherModeStreamOptions)	为流创建 html 视图。
disposeLocalVideoStreamView()	释放本地视频流的 html 视图
disposeRemoteVideoStreamView(string)	释放远端视频流的 html 视图
disposeScreenShareStreamView(string)	释放屏幕共享流的 html 视图
disposeStreamView(string, VideoStreamOptions)	释放流的 html 视图。
disposeTogetherModeStreamView()	释放流的 html 视图。
forbidAudio(string[])	禁止 Teams 与会者通过其用户 ID 进行音频。
forbidOthersAudio()	禁止 Teams 会议音频。
forbidOthersVideo()	禁止 Teams 会议视频。
forbidVideo(string[])	通过用户 ID 禁止 Teams 与会者观看视频。
holdCall()	保持呼叫。
leaveCall(boolean)	离开呼叫
lowerHand()	当前用户降低
mute()	在本地呼叫期间将当前用户静音或禁用麦克风
muteAllRemoteParticipants()	将所有参与者静音
muteParticipant(string)	将参与者静音
onReactionClick(Reaction)	发送反应表情符号
permitAudio(string[])	允许 Teams 与会者通过其用户 ID 进行音频会议。
permitOthersAudio()	允许 Teams 会议音频。
permitOthersVideo()	允许 Teams 会议视频。
permitVideo(string[])	允许 Teams 与会者通过其用户 ID 进行音频会议。
raiseHand()	为当前用户举手
removeParticipant(CommunicationIdentifier)	从呼叫中删除参与者。
removeParticipant(string)	从呼叫中删除参与者。
resumeCall()	从状态 `LocalHold` 恢复调用。
returnFromBreakoutRoom()	返回分组讨论室的源站呼叫
sendDtmfTone(DtmfTone)	向 1 对 1 PSTN 呼叫中的另一位参与者发送 DTMF 音调
setCaptionLanguage(string)	设置字幕语言的功能
setSpokenLanguage(string)	设置口语的功能
setTogetherModeSceneSize(number, number)	重新计算 Together 模式的座位位置。
startCamera(VideoStreamOptions)	启动相机此方法将在调用未处于活动状态时开始呈现本地相机视图
startCaptions(StartCaptionsAdapterOptions)	启动字幕的功能
startNoiseSuppressionEffect()	启动噪声抑制效果。
startScreenShare()	开始在通话期间共享屏幕。
startSpotlight(string[])	按本地和远程参与者的用户 ID 启动聚焦。如果未传递用户 ID 数组，则对本地参与者执行作。
startTogetherMode()	“一起启动”模式。
startVideoBackgroundEffect(VideoBackgroundEffect)	启动视频背景效果。
stopAllSpotlight()	停止所有聚光灯
stopCamera()	停止相机此方法将在调用未处于活动状态时停止呈现本地相机视图
stopCaptions(StopCaptionsAdapterOptions)	停止字幕的功能
stopNoiseSuppressionEffect()	停止噪声抑制效果。
stopScreenShare()	停止共享屏幕
stopSpotlight(string[])	通过用户 ID 为本地和远程参与者停止聚焦。如果未传递用户 ID 数组，则对本地参与者执行作。
stopVideoBackgroundEffects()	停止视频背景效果。
submitSurvey(CallSurvey)	发送通话结束调查结果
unmute()	在呼叫期间取消静音当前用户或在本地启用麦克风
updateBackgroundPickerImages(VideoBackgroundImage[])	覆盖背景选取器图像以获得背景替换效果。
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	更新所选视频背景效果。

继承属性详细信息

sendRealTimeText

发送实时文本

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

属性值

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

继承自CallAdapterCallOperations.sendRealTimeText

方法详细信息

joinCall(boolean)

警告

现已弃用此 API。

Use joinCall(options?:JoinCallOptions) instead.

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

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

参数

microphoneOn: boolean

是否最初启用麦克风

undefined | Call

joinCall(JoinCallOptions)

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

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

参数

options: JoinCallOptions

param 设置麦克风/摄像头初始开启/关闭/使用呼叫前状态。

undefined | Call

startCall(CommunicationIdentifier[], StartCallOptions)

启动呼叫。

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

参数

participants: CommunicationIdentifier[]

要调用的 <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> 数组

options: StartCallOptions

undefined | Call

startCall(string[], StartCallOptions)

启动呼叫。

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

参数

participants: string[]

要加入的参与者 ID 数组

options: StartCallOptions

undefined | Call

继承的方法详细信息

addParticipant(CommunicationUserIdentifier)

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

参数

participant: CommunicationUserIdentifier

Promise<void>

继承自CallAdapterCallOperations.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

将参与者添加到呼叫。

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

参数

participant: PhoneNumberIdentifier

options: AddPhoneNumberOptions

Promise<void>

继承自CallAdapterCallOperations.addParticipant

createStreamView(string, VideoStreamOptions)

为流创建 html 视图。

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

参数

remoteUserId: string

要呈现的参与者的 ID，使其未定义以创建本地相机视图

options: VideoStreamOptions

用于控制视频流呈现方式的选项 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Promise<void | CreateVideoStreamViewResult>

注解

此方法是针对复合实现的

继承自CallAdapterCallOperations.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

为流创建 html 视图。

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

参数

options: TogetherModeStreamOptions

用于控制视频流呈现方式的选项 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Promise<void | TogetherModeStreamViewResult>

注解

此方法是针对复合实现的

继承自CallAdapterCallOperations.createTogetherModeStreamView

disposeLocalVideoStreamView()

释放本地视频流的 html 视图

function disposeLocalVideoStreamView(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.disposeLocalVideoStreamView

disposeRemoteVideoStreamView(string)

释放远端视频流的 html 视图

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

参数

remoteUserId: string

要处置的参与者的 ID

Promise<void>

继承自CallAdapterCallOperations.disposeRemoteVideoStreamView

disposeScreenShareStreamView(string)

释放屏幕共享流的 html 视图

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

参数

remoteUserId: string

要为其处理屏幕共享流视图的参加者的 ID。

Promise<void>

注解

该方法为 composite 实现

继承自CallAdapterCallOperations.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

警告

现已弃用此 API。

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

释放流的 html 视图。

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

参数

remoteUserId: string

要呈现的参与者的 ID，使其未定义以释放本地相机视图

options: VideoStreamOptions

用于控制视频流呈现方式的选项 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Promise<void>

注解

此方法是针对复合实现的

继承自 CallAdapterCallOperations.disposeStreamView

disposeTogetherModeStreamView()

释放流的 html 视图。

function disposeTogetherModeStreamView(): Promise<void>

Promise<void>

注解

此方法是针对复合实现的

继承自CallAdapterCallOperations.disposeTogetherModeStreamView

forbidAudio(string[])

禁止 Teams 与会者通过其用户 ID 进行音频。

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

参数

userIds: string[]

Promise<void>

继承自CallAdapterCallOperations.forbidAudio

forbidOthersAudio()

禁止 Teams 会议音频。

function forbidOthersAudio(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.forbidOthersAudio

forbidOthersVideo()

禁止 Teams 会议视频。

function forbidOthersVideo(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.forbidOthersVideo

forbidVideo(string[])

通过用户 ID 禁止 Teams 与会者观看视频。

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

参数

userIds: string[]

Promise<void>

继承自CallAdapterCallOperations.forbidVideo

holdCall()

保持呼叫。

function holdCall(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.holdCall

leaveCall(boolean)

离开呼叫

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

参数

forEveryone: boolean

是否在离开时删除所有参与者

Promise<void>

继承自CallAdapterCallOperations.leaveCall

lowerHand()

当前用户降低

function lowerHand(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.lowerHand

mute()

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

function mute(): Promise<void>

Promise<void>

继承自 CallAdapterCallOperations.mute

muteAllRemoteParticipants()

将所有参与者静音

function muteAllRemoteParticipants(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.muteAllRemoteParticipants

muteParticipant(string)

将参与者静音

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

参数

userId: string

要静音的参与者的 ID

Promise<void>

继承自CallAdapterCallOperations.muteParticipant

onReactionClick(Reaction)

发送反应表情符号

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

参数

reaction: Reaction

Promise<void>

继承自CallAdapterCallOperations.onReactionClick

permitAudio(string[])

允许 Teams 与会者通过其用户 ID 进行音频会议。

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

参数

userIds: string[]

Promise<void>

继承自CallAdapterCallOperations.permitAudio

permitOthersAudio()

允许 Teams 会议音频。

function permitOthersAudio(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.permitOthersAudio

permitOthersVideo()

允许 Teams 会议视频。

function permitOthersVideo(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.permitOthersVideo

permitVideo(string[])

允许 Teams 与会者通过其用户 ID 进行音频会议。

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

参数

userIds: string[]

Promise<void>

继承自CallAdapterCallOperations.permitVideo

raiseHand()

为当前用户举手

function raiseHand(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.raiseHand

removeParticipant(CommunicationIdentifier)

从呼叫中删除参与者。

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

参数

participant: CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> 要删除的参与者

Promise<void>

继承自 CallAdapterCallOperations.removeParticipant

removeParticipant(string)

从呼叫中删除参与者。

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

参数

userId: string

要删除的参与者的 ID

Promise<void>

继承自 CallAdapterCallOperations.removeParticipant

resumeCall()

从状态 LocalHold 恢复调用。

function resumeCall(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.resumeCall

returnFromBreakoutRoom()

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

function returnFromBreakoutRoom(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.returnFromBreakoutRoom

sendDtmfTone(DtmfTone)

向 1 对 1 PSTN 呼叫中的另一位参与者发送 DTMF 音调

function sendDtmfTone(dtmfTone: DtmfTone): Promise<void>

参数

dtmfTone: DtmfTone

Promise<void>

继承自CallAdapterCallOperations.sendDtmfTone

setCaptionLanguage(string)

设置字幕语言的功能

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

参数

language: string

为字幕设置的语言

Promise<void>

继承自CallAdapterCallOperations.setCaptionLanguage

setSpokenLanguage(string)

设置口语的功能

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

参数

language: string

口语

Promise<void>

继承自CallAdapterCallOperations.setSpokenLanguage

setTogetherModeSceneSize(number, number)

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

function setTogetherModeSceneSize(width: number, height: number)

参数

width: number

容器的宽度

height: number

容器的高度

注解

此方法是针对复合实现的

继承自CallAdapterCallOperations.setTogetherModeSceneSize

startCamera(VideoStreamOptions)

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

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

参数

options: VideoStreamOptions

用于控制视频流呈现方式的选项 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Promise<void>

继承自CallAdapterCallOperations.startCamera

startCaptions(StartCaptionsAdapterOptions)

启动字幕的功能

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

参数

options: StartCaptionsAdapterOptions

开始字幕的选项

Promise<void>

继承自CallAdapterCallOperations.startCaptions

startNoiseSuppressionEffect()

启动噪声抑制效果。

function startNoiseSuppressionEffect(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.startNoiseSuppressionEffect

startScreenShare()

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

function startScreenShare(): Promise<void>

Promise<void>

继承自 CallAdapterCallOperations.startScreenShare

startSpotlight(string[])

按本地和远程参与者的用户 ID 启动聚焦。如果未传递用户 ID 数组，则对本地参与者执行作。

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

参数

userIds: string[]

Promise<void>

继承自CallAdapterCallOperations.startSpotlight

startTogetherMode()

“一起启动”模式。

function startTogetherMode(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

启动视频背景效果。

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

参数

videoBackgroundEffect: VideoBackgroundEffect

Promise<void>

继承自CallAdapterCallOperations.startVideoBackgroundEffect

stopAllSpotlight()

停止所有聚光灯

function stopAllSpotlight(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.stopAllSpotlight

stopCamera()

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

function stopCamera(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

停止字幕的功能

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

参数

options: StopCaptionsAdapterOptions

Promise<void>

继承自CallAdapterCallOperations.stopCaptions

stopNoiseSuppressionEffect()

停止噪声抑制效果。

function stopNoiseSuppressionEffect(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.stopNoiseSuppressionEffect

stopScreenShare()

停止共享屏幕

function stopScreenShare(): Promise<void>

Promise<void>

继承自 CallAdapterCallOperations.stopScreenShare

stopSpotlight(string[])

通过用户 ID 为本地和远程参与者停止聚焦。如果未传递用户 ID 数组，则对本地参与者执行作。

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

参数

userIds: string[]

Promise<void>

继承自CallAdapterCallOperations.stopSpotlight

stopVideoBackgroundEffects()

停止视频背景效果。

function stopVideoBackgroundEffects(): Promise<void>

Promise<void>

继承自CallAdapterCallOperations.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

发送通话结束调查结果

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

参数

survey: CallSurvey

Promise<undefined | CallSurveyResponse>

继承自CallAdapterCallOperations.submitSurvey

unmute()

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

function unmute(): Promise<void>

Promise<void>

继承自 CallAdapterCallOperations.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

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

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

参数

backgroundImages: VideoBackgroundImage[]

自定义背景图像数组。

继承自CallAdapterCallOperations.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

更新所选视频背景效果。

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

参数

selectedVideoBackground: VideoBackgroundEffect

继承自CallAdapterCallOperations.updateSelectedVideoBackgroundEffect