TeamsCallAdapter interface
特定于 Teams 标识的 Adapter 接口，用于扩展 CommonCallAdapter。
继承属性
| send |
发送实时文本 |
方法
| join |
最初打开/关闭麦克风加入呼叫。 |
| join |
使用选项包加入通话，在加入通话时设置麦克风/摄像头初始状态 true = 加入通话时打开设备 false = 加入通话时关闭设备 'keep'/undefined = 保留设备的通话前状态 |
| start |
启动呼叫。 |
| start |
启动呼叫。 |
继承的方法
继承属性详细信息
sendRealTimeText
发送实时文本
sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>属性值
(text: string, isFinalized: boolean) => Promise<void>
方法详细信息
joinCall(boolean)
警告
现已弃用此 API。
Use joinCall(options?:JoinCallOptions) instead.
最初打开/关闭麦克风加入呼叫。
function joinCall(microphoneOn?: boolean): undefined | TeamsCall参数
- microphoneOn
-
boolean
是否最初启用麦克风
返回
undefined | TeamsCall
joinCall(JoinCallOptions)
使用选项包加入通话，在加入通话时设置麦克风/摄像头初始状态 true = 加入通话时打开设备 false = 加入通话时关闭设备 'keep'/undefined = 保留设备的通话前状态
function joinCall(options?: JoinCallOptions): undefined | TeamsCall参数
- options
- JoinCallOptions
param 设置麦克风/摄像头的初始打开/关闭。
返回
undefined | TeamsCall
startCall(CommunicationIdentifier[], StartCallOptions)
启动呼叫。
function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): undefined | TeamsCall参数
- participants
要调用的 <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> 数组
- options
- StartCallOptions
返回
undefined | TeamsCall
startCall(string[], StartCallOptions)
启动呼叫。
function startCall(participants: string[], options?: StartCallOptions): undefined | TeamsCall参数
- participants
-
string[]
要加入的参与者 ID 数组
- options
- StartCallOptions
返回
undefined | TeamsCall
继承的方法详细信息
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>
askDevicePermission(PermissionConstraints)
请求设备的权限。
function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>参数
- constrain
- PermissionConstraints
定义访问本地设备 <xref:%40azure%2Fcommunication-calling%23PermissionConstraints> 的约束
返回
Promise<DeviceAccess>
注解
如果尚未授予权限，浏览器权限窗口将弹出
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>
注解
此方法是针对复合实现的
dispose()
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>
getState()
holdCall()
leaveCall(boolean)
离开呼叫
function leaveCall(forEveryone?: boolean): Promise<void>参数
- forEveryone
-
boolean
是否在离开时删除所有参与者
返回
Promise<void>
lowerHand()
mute()
muteAllRemoteParticipants()
将所有参与者静音
function muteAllRemoteParticipants(): Promise<void>返回
Promise<void>
muteParticipant(string)
将参与者静音
function muteParticipant(userId: string): Promise<void>参数
- userId
-
string
要静音的参与者的 ID
返回
Promise<void>
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
“breakoutRoomsUpdated”事件的取消订阅函数。
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)参数
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
off("callEnded", CallEndedListener)
取消订阅“callEnded”事件的函数。
function off(event: "callEnded", listener: CallEndedListener)参数
- event
-
"callEnded"
- listener
- CallEndedListener
off("callIdChanged", CallIdChangedListener)
取消订阅“callIdChanged”事件的函数。
function off(event: "callIdChanged", listener: CallIdChangedListener)参数
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
off("capabilitiesChanged", CapabilitiesChangedListener)
unsubscribe 函数。
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)参数
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
off("captionsReceived", CaptionsReceivedListener)
'captionsReceived' 事件的取消订阅函数。
function off(event: "captionsReceived", listener: CaptionsReceivedListener)参数
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
off("diagnosticChanged", DiagnosticChangedEventListner)
取消订阅“diagnosticChanged”事件的函数。
function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)参数
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
off("displayNameChanged", DisplayNameChangedListener)
取消订阅“displayNameChanged”事件的函数。
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)参数
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
off("error", (e: AdapterError) => void)
取消订阅“error”事件的函数。
function off(event: "error", listener: (e: AdapterError) => void)参数
- event
-
"error"
- listener
-
(e: AdapterError) => void
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
取消订阅函数。
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)参数
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
'isCaptionsActiveChanged' 事件的取消订阅函数。
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)参数
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
取消订阅“isLocalScreenSharingActiveChanged”事件的函数。
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)参数
- event
-
"isLocalScreenSharingActiveChanged"
off("isMutedChanged", IsMutedChangedListener)
取消订阅“isMutedChanged”事件的函数。
function off(event: "isMutedChanged", listener: IsMutedChangedListener)参数
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
off("isSpeakingChanged", IsSpeakingChangedListener)
取消订阅“isSpeakingChanged”事件的函数。
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)参数
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
'isSpokenLanguageChanged' 事件的取消订阅函数。
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)参数
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
off("mutedByOthers", PropertyChangedEvent)
'mutedByOthers' 事件的 Unsubscribe 函数。
function off(event: "mutedByOthers", listener: PropertyChangedEvent)参数
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
off("participantsJoined", ParticipantsJoinedListener)
取消订阅“participantsJoined”事件的函数。
function off(event: "participantsJoined", listener: ParticipantsJoinedListener)参数
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
off("participantsLeft", ParticipantsLeftListener)
取消订阅“participantsLeft”事件的函数。
function off(event: "participantsLeft", listener: ParticipantsLeftListener)参数
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
off("realTimeTextReceived", RealTimeTextReceivedListener)
'realTimeTextReceived' 事件的 Unsubscribe 函数。
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)参数
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
off("roleChanged", PropertyChangedEvent)
'roleChanged' 事件的 Unsubscribe 函数。
function off(event: "roleChanged", listener: PropertyChangedEvent)参数
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
off("selectedMicrophoneChanged", PropertyChangedEvent)
取消订阅“selectedMicrophoneChanged”事件的函数。
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)参数
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
off("selectedSpeakerChanged", PropertyChangedEvent)
取消订阅“selectedSpeakerChanged”事件的函数。
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)参数
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
off("spotlightChanged", SpotlightChangedListener)
unsubscribe 函数。
function off(event: "spotlightChanged", listener: SpotlightChangedListener)参数
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
off("transferAccepted", TransferAcceptedListener)
unsubscribe 函数。
function off(event: "transferAccepted", listener: TransferAcceptedListener)参数
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
offStateChange((state: CallAdapterState) => void)
取消订阅处理程序到 stateChanged 事件。
function offStateChange(handler: (state: CallAdapterState) => void)参数
- handler
-
(state: CallAdapterState) => void
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
“breakoutRoomsUpdated”事件的订阅函数。
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)参数
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
on("callEnded", CallEndedListener)
订阅“callEnded”事件的函数。
function on(event: "callEnded", listener: CallEndedListener)参数
- event
-
"callEnded"
- listener
- CallEndedListener
on("callIdChanged", CallIdChangedListener)
订阅“callIdChanged”事件的函数。
function on(event: "callIdChanged", listener: CallIdChangedListener)参数
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
注解
当当前用户的 callId 发生更改时，将触发该事件。
on("capabilitiesChanged", CapabilitiesChangedListener)
'capabilitiesChanged' 事件的 Subscribe 函数。
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)参数
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
on("captionsReceived", CaptionsReceivedListener)
'captionsReceived' 事件的订阅函数。
function on(event: "captionsReceived", listener: CaptionsReceivedListener)参数
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
on("diagnosticChanged", DiagnosticChangedEventListner)
订阅“diagnosticChanged”事件的函数。
每当用户面临有关正在进行的呼叫的诊断发生更改时，此事件将触发。
function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)参数
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
on("displayNameChanged", DisplayNameChangedListener)
订阅“displayNameChanged”事件的函数。
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)参数
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
on("error", (e: AdapterError) => void)
订阅“error”事件的函数。
function on(event: "error", listener: (e: AdapterError) => void)参数
- event
-
"error"
- listener
-
(e: AdapterError) => void
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
订阅 'isCaptionLanguageChanged' 事件的函数。
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)参数
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
“isCaptionsActiveChanged”事件的订阅函数。
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)参数
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
订阅“isLocalScreenSharingActiveChanged”事件的订阅函数。
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)参数
- event
-
"isLocalScreenSharingActiveChanged"
on("isMutedChanged", IsMutedChangedListener)
订阅“isMutedChanged”事件的订阅函数。
function on(event: "isMutedChanged", listener: IsMutedChangedListener)参数
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
注解
每当当前用户或远程用户静音状态发生更改时，都会触发该事件
on("isSpeakingChanged", IsSpeakingChangedListener)
订阅“isSpeakingChanged”事件的函数。
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)参数
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
订阅 'isSpokenLanguageChanged' 事件的函数。
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)参数
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
on("mutedByOthers", PropertyChangedEvent)
'mutedByOthers' 事件的 subscribe 函数。
function on(event: "mutedByOthers", listener: PropertyChangedEvent)参数
- event
-
"mutedByOthers"
- listener
- PropertyChangedEvent
on("participantsJoined", ParticipantsJoinedListener)
订阅“participantsJoined”事件的函数。
function on(event: "participantsJoined", listener: ParticipantsJoinedListener)参数
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
on("participantsLeft", ParticipantsLeftListener)
订阅“participantsLeft”事件的函数。
function on(event: "participantsLeft", listener: ParticipantsLeftListener)参数
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
on("realTimeTextReceived", RealTimeTextReceivedListener)
'realTimeTextReceived' 事件的订阅函数。
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)参数
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
on("roleChanged", PropertyChangedEvent)
'roleChanged' 事件的 Subscribe 函数。
function on(event: "roleChanged", listener: PropertyChangedEvent)参数
- event
-
"roleChanged"
- listener
- PropertyChangedEvent
on("selectedMicrophoneChanged", PropertyChangedEvent)
订阅“selectedMicrophoneChanged”事件的函数。
每当用户选择新的麦克风设备时，此事件将触发。
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)参数
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
on("selectedSpeakerChanged", PropertyChangedEvent)
订阅“selectedSpeakerChanged”事件的函数。
每当用户选择新的扬声器设备时，就会触发此事件。
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)参数
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
on("spotlightChanged", SpotlightChangedListener)
'spotlightChanged' 事件的订阅函数。
function on(event: "spotlightChanged", listener: SpotlightChangedListener)参数
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
on("transferAccepted", TransferAcceptedListener)
'transferRequested' 事件的 Subscribe 函数。
function on(event: "transferAccepted", listener: TransferAcceptedListener)参数
- event
-
"transferAccepted"
- listener
- TransferAcceptedListener
onReactionClick(Reaction)
发送反应表情符号
function onReactionClick(reaction: Reaction): Promise<void>参数
- reaction
- Reaction
返回
Promise<void>
onStateChange((state: CallAdapterState) => void)
将处理程序订阅到 stateChanged 事件。
function onStateChange(handler: (state: CallAdapterState) => void)参数
- handler
-
(state: CallAdapterState) => 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>
queryCameras()
查询可用的相机设备。
function queryCameras(): Promise<VideoDeviceInfo[]>返回
Promise<VideoDeviceInfo[]>
视频设备信息实体数组 <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
注解
应在 askDevicePermission（） 后调用此方法
queryMicrophones()
查询可用的麦克风设备。
function queryMicrophones(): Promise<AudioDeviceInfo[]>返回
Promise<AudioDeviceInfo[]>
音频设备信息实体数组 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
注解
应在 askDevicePermission（） 后调用此方法
querySpeakers()
查询可用的扬声器设备。
function querySpeakers(): Promise<AudioDeviceInfo[]>返回
Promise<AudioDeviceInfo[]>
音频设备信息实体数组 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
注解
应在 askDevicePermission（） 后调用此方法
raiseHand()
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>
setCamera(VideoDeviceInfo, VideoStreamOptions)
将相机设置为在呼叫中使用。
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>参数
- sourceInfo
- VideoDeviceInfo
要选择的相机设备，选择由 queryCameras 返回的一个
- options
- VideoStreamOptions
用于控制相机流呈现方式的选项 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
返回
Promise<void>
setCaptionLanguage(string)
设置字幕语言的功能
function setCaptionLanguage(language: string): Promise<void>参数
- language
-
string
为字幕设置的语言
返回
Promise<void>
setMicrophone(AudioDeviceInfo)
将麦克风设置为在呼叫中使用。
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>参数
- sourceInfo
- AudioDeviceInfo
要选择的麦克风设备，选择由 queryMicrophones 返回的一个
返回
Promise<void>
setSpeaker(AudioDeviceInfo)
将扬声器设置为在呼叫中使用。
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>参数
- sourceInfo
- AudioDeviceInfo
要选择的扬声器设备，选择由 querySpeakers 返回的一个
返回
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