CallAdapterCallOperations interface
用于管理当前调用的功能。
属性
| send |
发送实时文本 |
方法
属性详细信息
sendRealTimeText
发送实时文本
sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>
属性值
(text: string, isFinalized: boolean) => Promise<void>
方法详细信息
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>
参数
- participant
- CommunicationUserIdentifier
返回
Promise<void>
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
将参与者添加到呼叫。
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>
参数
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
返回
Promise<void>
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>
注解
此方法是针对复合实现的
createTogetherModeStreamView(TogetherModeStreamOptions)
为流创建 html 视图。
function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>
参数
- options
- TogetherModeStreamOptions
用于控制视频流呈现方式的选项 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
返回
Promise<void | TogetherModeStreamViewResult>
注解
此方法是针对复合实现的
disposeLocalVideoStreamView()
释放本地视频流的 html 视图
function disposeLocalVideoStreamView(): Promise<void>
返回
Promise<void>
disposeRemoteVideoStreamView(string)
释放远端视频流的 html 视图
function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>
参数
- remoteUserId
-
string
要处置的参与者的 ID
返回
Promise<void>
disposeScreenShareStreamView(string)
释放屏幕共享流的 html 视图
function disposeScreenShareStreamView(remoteUserId: string): Promise<void>
参数
- remoteUserId
-
string
要为其处理屏幕共享流视图的参加者的 ID。
返回
Promise<void>
注解
该方法为 composite 实现
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>
注解
此方法是针对复合实现的
disposeTogetherModeStreamView()
释放流的 html 视图。
function disposeTogetherModeStreamView(): Promise<void>
返回
Promise<void>
注解
此方法是针对复合实现的
forbidAudio(string[])
禁止 Teams 与会者通过其用户 ID 进行音频。
function forbidAudio(userIds: string[]): Promise<void>
参数
- userIds
-
string[]
返回
Promise<void>
forbidOthersAudio()
禁止 Teams 会议音频。
function forbidOthersAudio(): Promise<void>
返回
Promise<void>
forbidOthersVideo()
禁止 Teams 会议视频。
function forbidOthersVideo(): Promise<void>
返回
Promise<void>
forbidVideo(string[])
通过用户 ID 禁止 Teams 与会者观看视频。
function forbidVideo(userIds: string[]): Promise<void>
参数
- userIds
-
string[]
返回
Promise<void>
holdCall()
保持呼叫。
function holdCall(): Promise<void>
返回
Promise<void>
leaveCall(boolean)
离开呼叫
function leaveCall(forEveryone?: boolean): Promise<void>
参数
- forEveryone
-
boolean
是否在离开时删除所有参与者
返回
Promise<void>
lowerHand()
当前用户降低
function lowerHand(): Promise<void>
返回
Promise<void>
mute()
在本地呼叫期间将当前用户静音或禁用麦克风
function mute(): Promise<void>
返回
Promise<void>
muteAllRemoteParticipants()
将所有参与者静音
function muteAllRemoteParticipants(): Promise<void>
返回
Promise<void>
muteParticipant(string)
将参与者静音
function muteParticipant(userId: string): Promise<void>
参数
- userId
-
string
要静音的参与者的 ID
返回
Promise<void>
onReactionClick(Reaction)
发送反应表情符号
function onReactionClick(reaction: Reaction): Promise<void>
参数
- reaction
- Reaction
返回
Promise<void>
permitAudio(string[])
允许 Teams 与会者通过其用户 ID 进行音频会议。
function permitAudio(userIds: string[]): Promise<void>
参数
- userIds
-
string[]
返回
Promise<void>
permitOthersAudio()
允许 Teams 会议音频。
function permitOthersAudio(): Promise<void>
返回
Promise<void>
permitOthersVideo()
允许 Teams 会议视频。
function permitOthersVideo(): Promise<void>
返回
Promise<void>
permitVideo(string[])
允许 Teams 与会者通过其用户 ID 进行音频会议。
function permitVideo(userIds: string[]): Promise<void>
参数
- userIds
-
string[]
返回
Promise<void>
raiseHand()
为当前用户举手
function raiseHand(): Promise<void>
返回
Promise<void>
removeParticipant(CommunicationIdentifier)
从呼叫中删除参与者。
function removeParticipant(participant: CommunicationIdentifier): Promise<void>
参数
- participant
- CommunicationIdentifier
<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> 要删除的参与者
返回
Promise<void>
removeParticipant(string)
从呼叫中删除参与者。
function removeParticipant(userId: string): Promise<void>
参数
- userId
-
string
要删除的参与者的 ID
返回
Promise<void>
resumeCall()
从状态 LocalHold 恢复调用。
function resumeCall(): Promise<void>
返回
Promise<void>
returnFromBreakoutRoom()
返回分组讨论室的源站呼叫
function returnFromBreakoutRoom(): Promise<void>
返回
Promise<void>
sendDtmfTone(DtmfTone)
向 1 对 1 PSTN 呼叫中的另一位参与者发送 DTMF 音调
function sendDtmfTone(dtmfTone: DtmfTone): Promise<void>
参数
- dtmfTone
- DtmfTone
返回
Promise<void>
setCaptionLanguage(string)
设置字幕语言的功能
function setCaptionLanguage(language: string): Promise<void>
参数
- language
-
string
为字幕设置的语言
返回
Promise<void>
setSpokenLanguage(string)
设置口语的功能
function setSpokenLanguage(language: string): Promise<void>
参数
- language
-
string
口语
返回
Promise<void>
setTogetherModeSceneSize(number, number)
重新计算 Together 模式的座位位置。
function setTogetherModeSceneSize(width: number, height: number)
参数
- width
-
number
容器的宽度
- height
-
number
容器的高度
注解
此方法是针对复合实现的
startCamera(VideoStreamOptions)
启动相机 此方法将在调用未处于活动状态时开始呈现本地相机视图
function startCamera(options?: VideoStreamOptions): Promise<void>
参数
- options
- VideoStreamOptions
用于控制视频流呈现方式的选项 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
返回
Promise<void>
startCaptions(StartCaptionsAdapterOptions)
启动字幕的功能
function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>
参数
- options
- StartCaptionsAdapterOptions
开始字幕的选项
返回
Promise<void>
startNoiseSuppressionEffect()
启动噪声抑制效果。
function startNoiseSuppressionEffect(): Promise<void>
返回
Promise<void>
startScreenShare()
开始在通话期间共享屏幕。
function startScreenShare(): Promise<void>
返回
Promise<void>
startSpotlight(string[])
按本地和远程参与者的用户 ID 启动聚焦。 如果未传递用户 ID 数组,则对本地参与者执行作。
function startSpotlight(userIds?: string[]): Promise<void>
参数
- userIds
-
string[]
返回
Promise<void>
startTogetherMode()
“一起启动”模式。
function startTogetherMode(): Promise<void>
返回
Promise<void>
startVideoBackgroundEffect(VideoBackgroundEffect)
启动视频背景效果。
function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>
参数
- videoBackgroundEffect
- VideoBackgroundEffect
返回
Promise<void>
stopAllSpotlight()
停止所有聚光灯
function stopAllSpotlight(): Promise<void>
返回
Promise<void>
stopCamera()
停止相机 此方法将在调用未处于活动状态时停止呈现本地相机视图
function stopCamera(): Promise<void>
返回
Promise<void>
stopCaptions(StopCaptionsAdapterOptions)
停止字幕的功能
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>
参数
- options
- StopCaptionsAdapterOptions
返回
Promise<void>
stopNoiseSuppressionEffect()
停止噪声抑制效果。
function stopNoiseSuppressionEffect(): Promise<void>
返回
Promise<void>
stopScreenShare()
停止共享屏幕
function stopScreenShare(): Promise<void>
返回
Promise<void>
stopSpotlight(string[])
通过用户 ID 为本地和远程参与者停止聚焦。 如果未传递用户 ID 数组,则对本地参与者执行作。
function stopSpotlight(userIds?: string[]): Promise<void>
参数
- userIds
-
string[]
返回
Promise<void>
stopVideoBackgroundEffects()
停止视频背景效果。
function stopVideoBackgroundEffects(): Promise<void>
返回
Promise<void>
submitSurvey(CallSurvey)
发送通话结束调查结果
function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>
参数
- survey
- CallSurvey
返回
Promise<undefined | CallSurveyResponse>
unmute()
在呼叫期间取消静音当前用户或在本地启用麦克风
function unmute(): Promise<void>
返回
Promise<void>
updateBackgroundPickerImages(VideoBackgroundImage[])
覆盖背景选取器图像以获得背景替换效果。
function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])
参数
- backgroundImages
自定义背景图像数组。
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
更新所选视频背景效果。
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
参数
- selectedVideoBackground
- VideoBackgroundEffect