CallWithChatAdapter interface
CallWithChatComposite 适配器接口。
- 扩展
继承属性
| forbid |
禁止对指定的 User ID 进行音频作。 |
| forbid |
禁止 Teams 会议与会者（本地用户除外）使用音频。 |
| forbid |
禁止 Teams 会议与会者（本地用户除外）观看视频。 |
| forbid |
禁止指定 User ID 的视频。 |
| permit |
允许指定 User ID 的音频。 |
| permit |
允许 Teams 会议与会者（本地用户除外）使用音频。 |
| permit |
允许 Teams 会议与会者（本地用户除外）观看视频。 |
| permit |
允许指定用户 ID 的视频。 |
| send |
在 1 对 1 通话中向呼叫中的其他参与者发送 DTMF 音调 |
| send |
发送实时文本 |
继承的方法
继承属性详细信息
forbidAudio
禁止对指定的 User ID 进行音频作。
forbidAudio: (userIds: string[]) => Promise<void>属性值
(userIds: string[]) => Promise<void>
forbidOthersAudio
禁止 Teams 会议与会者（本地用户除外）使用音频。
forbidOthersAudio: () => Promise<void>属性值
() => Promise<void>
forbidOthersVideo
禁止 Teams 会议与会者（本地用户除外）观看视频。
forbidOthersVideo: () => Promise<void>属性值
() => Promise<void>
forbidVideo
禁止指定 User ID 的视频。
forbidVideo: (userIds: string[]) => Promise<void>属性值
(userIds: string[]) => Promise<void>
permitAudio
允许指定 User ID 的音频。
permitAudio: (userIds: string[]) => Promise<void>属性值
(userIds: string[]) => Promise<void>
permitOthersAudio
允许 Teams 会议与会者（本地用户除外）使用音频。
permitOthersAudio: () => Promise<void>属性值
() => Promise<void>
permitOthersVideo
允许 Teams 会议与会者（本地用户除外）观看视频。
permitOthersVideo: () => Promise<void>属性值
() => Promise<void>
permitVideo
允许指定用户 ID 的视频。
permitVideo: (userIds: string[]) => Promise<void>属性值
(userIds: string[]) => Promise<void>
sendDtmfTone
在 1 对 1 通话中向呼叫中的其他参与者发送 DTMF 音调
public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>属性值
(dtmfTone: DtmfTone) => Promise<void>
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>
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)
为 togethermode 流创建 html 视图。
function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>参数
- options
- TogetherModeStreamOptions
用于控制视频流呈现方式的选项 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
返回
Promise<void | TogetherModeStreamViewResult>
注解
此方法是针对复合实现的
继承自CallWithChatAdapterManagement.createTogetherModeStreamView
deleteMessage(string)
删除线程中的消息。
function deleteMessage(messageId: string): Promise<void>参数
- messageId
-
string
返回
Promise<void>
dispose()
disposeLocalVideoStreamView()
释放本地视频流的 html 视图
function disposeLocalVideoStreamView(): Promise<void>返回
Promise<void>
继承自CallWithChatAdapterManagement.disposeLocalVideoStreamView
disposeRemoteVideoStreamView(string)
释放远端视频流的 html 视图
function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>参数
- remoteUserId
-
string
要处置的参与者的 ID
返回
Promise<void>
继承自CallWithChatAdapterManagement.disposeRemoteVideoStreamView
disposeScreenShareStreamView(string)
释放屏幕共享流的 html 视图
function disposeScreenShareStreamView(remoteUserId: string): Promise<void>参数
- remoteUserId
-
string
要为其处理屏幕共享流视图的参加者的 ID。
返回
Promise<void>
注解
该方法为 composite 实现
继承自CallWithChatAdapterManagement.disposeScreenShareStreamView
disposeStreamView(string, VideoStreamOptions)
释放流的 html 视图。
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>参数
- remoteUserId
-
string
要呈现的参与者的 ID，使其未定义以释放本地相机视图
- options
- VideoStreamOptions
用于控制视频流呈现方式的选项 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
返回
Promise<void>
注解
此方法是针对复合实现的。
disposeTogetherModeStreamView()
释放 togethermode 流的 html 视图。
function disposeTogetherModeStreamView(): Promise<void>返回
Promise<void>
注解
此方法是针对复合实现的
继承自CallWithChatAdapterManagement.disposeTogetherModeStreamView
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>参数
- resourceDetails
- ResourceDetails
返回
Promise<void>
fetchInitialData()
提取聊天适配器的初始状态。
执行 ChatComposite 和 API 方法所需的最小提取。
function fetchInitialData(): Promise<void>返回
Promise<void>
getState()
获取当前状态
function getState(): CallWithChatAdapterState返回
holdCall()
将呼叫置于本地保留中。
function holdCall(): Promise<void>返回
Promise<void>
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
leaveCall(boolean)
离开呼叫。
function leaveCall(forEveryone?: boolean): Promise<void>参数
- forEveryone
-
boolean
是否在离开时删除所有参与者
返回
Promise<void>
loadPreviousChatMessages(number)
在聊天线程历史记录中加载更多以前的消息。
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>参数
- messagesToLoad
-
number
返回
Promise<boolean>
注解
此方法通常用于控制增量提取/无限滚动。
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
返回
Promise<void>
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)参数
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
off("callEnded", CallEndedListener)
function off(event: "callEnded", listener: CallEndedListener)参数
- event
-
"callEnded"
- listener
- CallEndedListener
off("callError", (e: AdapterError) => void)
function off(event: "callError", listener: (e: AdapterError) => void)参数
- event
-
"callError"
- listener
-
(e: AdapterError) => void
off("callIdChanged", CallIdChangedListener)
function off(event: "callIdChanged", listener: CallIdChangedListener)参数
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
off("callParticipantsJoined", ParticipantsJoinedListener)
function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)参数
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
off("callParticipantsLeft", ParticipantsLeftListener)
function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)参数
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
off("capabilitiesChanged", CapabilitiesChangedListener)
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)参数
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
off("captionsReceived", CaptionsReceivedListener)
function off(event: "captionsReceived", listener: CaptionsReceivedListener)参数
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
off("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)参数
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
off("chatInitialized", ChatInitializedListener)
function off(event: "chatInitialized", listener: ChatInitializedListener)参数
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
off("chatParticipantsAdded", ParticipantsAddedListener)
function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)参数
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
off("chatParticipantsRemoved", ParticipantsRemovedListener)
function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)参数
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
off("displayNameChanged", DisplayNameChangedListener)
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)参数
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)参数
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)参数
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)参数
- event
-
"isLocalScreenSharingActiveChanged"
off("isMutedChanged", IsMutedChangedListener)
function off(event: "isMutedChanged", listener: IsMutedChangedListener)参数
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
off("isSpeakingChanged", IsSpeakingChangedListener)
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)参数
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)参数
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
off("messageDeleted", MessageReceivedListener)
function off(event: "messageDeleted", listener: MessageReceivedListener)参数
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
off("messageEdited", MessageReceivedListener)
function off(event: "messageEdited", listener: MessageReceivedListener)参数
- event
-
"messageEdited"
- listener
- MessageReceivedListener
off("messageRead", MessageReadListener)
function off(event: "messageRead", listener: MessageReadListener)参数
- event
-
"messageRead"
- listener
- MessageReadListener
off("messageReceived", MessageReceivedListener)
function off(event: "messageReceived", listener: MessageReceivedListener)参数
- event
-
"messageReceived"
- listener
- MessageReceivedListener
off("messageSent", MessageReceivedListener)
function off(event: "messageSent", listener: MessageReceivedListener)参数
- event
-
"messageSent"
- listener
- MessageReceivedListener
off("realTimeTextReceived", RealTimeTextReceivedListener)
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)参数
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
off("selectedMicrophoneChanged", PropertyChangedEvent)
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)参数
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
off("selectedSpeakerChanged", PropertyChangedEvent)
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)参数
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
off("spotlightChanged", SpotlightChangedListener)
function off(event: "spotlightChanged", listener: SpotlightChangedListener)参数
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
offStateChange((state: CallWithChatAdapterState) => void)
取消订阅处理程序到 stateChanged 事件。
function offStateChange(handler: (state: CallWithChatAdapterState) => void)参数
- handler
-
(state: CallWithChatAdapterState) => void
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)参数
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)参数
- event
-
"callEnded"
- listener
- CallEndedListener
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)参数
- event
-
"callError"
- listener
-
(e: AdapterError) => void
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)参数
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)参数
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)参数
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
on("capabilitiesChanged", CapabilitiesChangedListener)
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)参数
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
on("captionsReceived", CaptionsReceivedListener)
function on(event: "captionsReceived", listener: CaptionsReceivedListener)参数
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)参数
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
on("chatInitialized", ChatInitializedListener)
function on(event: "chatInitialized", listener: ChatInitializedListener)参数
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)参数
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)参数
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)参数
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)参数
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)参数
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)参数
- event
-
"isLocalScreenSharingActiveChanged"
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)参数
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)参数
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)参数
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
on("messageDeleted", MessageReceivedListener)
function on(event: "messageDeleted", listener: MessageReceivedListener)参数
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
on("messageEdited", MessageReceivedListener)
function on(event: "messageEdited", listener: MessageReceivedListener)参数
- event
-
"messageEdited"
- listener
- MessageReceivedListener
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)参数
- event
-
"messageRead"
- listener
- MessageReadListener
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)参数
- event
-
"messageReceived"
- listener
- MessageReceivedListener
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)参数
- event
-
"messageSent"
- listener
- MessageReceivedListener
on("realTimeTextReceived", RealTimeTextReceivedListener)
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)参数
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)参数
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)参数
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
on("spotlightChanged", SpotlightChangedListener)
function on(event: "spotlightChanged", listener: SpotlightChangedListener)参数
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
onReactionClick(Reaction)
将回应发送到正在进行的会议。
function onReactionClick(reaction: Reaction): Promise<void>参数
- reaction
- Reaction
type 为 <xref:%40azure%2Fcommunication-calling%23Reaction>
返回
Promise<void>
onStateChange((state: CallWithChatAdapterState) => void)
将处理程序订阅到 stateChanged 事件。
function onStateChange(handler: (state: CallWithChatAdapterState) => void)参数
- handler
-
(state: CallWithChatAdapterState) => 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()
向本地用户举手。
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
要删除的参与者的 UserId。
返回
Promise<void>
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)参数
- resourceDetails
- ResourceDetails
resumeCall()
从 LocalHold 状态恢复调用。
function resumeCall(): Promise<void>返回
Promise<void>
returnFromBreakoutRoom()
返回分组讨论室的源站呼叫
function returnFromBreakoutRoom(): Promise<void>返回
Promise<void>
sendMessage(string, SendMessageOptions)
在线程中发送消息。
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>参数
- content
-
string
- options
- SendMessageOptions
返回
Promise<void>
sendReadReceipt(string)
发送邮件的已读回执。
function sendReadReceipt(chatMessageId: string): Promise<void>参数
- chatMessageId
-
string
返回
Promise<void>
sendTypingIndicator()
在线程中发送键入指示器。
function sendTypingIndicator(): Promise<void>返回
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
容器的高度
注解
此方法是针对复合实现的
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
启动呼叫。
function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call参数
- participants
-
(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
要调用的 <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
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>
继承自CallWithChatAdapterManagement.startNoiseSuppressionEffect
startScreenShare()
开始在通话期间共享屏幕。
function startScreenShare(): Promise<void>返回
Promise<void>
startSpotlight(string[])
启动 spotlight
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[])
停止聚光灯
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
自定义背景图像数组。
继承自CallWithChatAdapterManagement.updateBackgroundPickerImages
updateMessage(string, string, Record<string, string>)
更新消息内容。
function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>参数
- messageId
-
string
- content
-
string
- options
-
Record<string, string>
返回
Promise<void>
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
更新选定的视频背景效果
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)参数
- selectedVideoBackground
- VideoBackgroundEffect
继承自CallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect