你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
CallAdapter interface
特定于 Azure 通信标识的适配器接口，用于扩展 CommonCallAdapter。
- Extends
方法
| join |
最初打开/关闭麦克风加入呼叫。 |
| start |
启动呼叫。 |
继承的方法
方法详细信息
joinCall(boolean)
最初打开/关闭麦克风加入呼叫。
function joinCall(microphoneOn?: boolean): undefined | Call参数
- microphoneOn
-
boolean
最初是否启用麦克风
返回
undefined | Call
startCall(string[], StartCallOptions)
启动呼叫。
function startCall(participants: string[], options?: StartCallOptions): undefined | Call参数
- participants
-
string[]
要加入的参与者 ID 数组
- options
- StartCallOptions
返回
undefined | Call
继承的方法详细信息
askDevicePermission(PermissionConstraints)
请求设备的权限。
function askDevicePermission(constrain: PermissionConstraints): Promise<void>参数
- constrain
- PermissionConstraints
定义访问本地设备的约束 <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
返回
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>
注解
此方法是针对复合实现的
dispose()
disposeStreamView(string, VideoStreamOptions)
释放流的 html 视图。
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>参数
- remoteUserId
-
string
要呈现的参与者的 ID，将其保留为未定义以释放本地相机视图
- options
- VideoStreamOptions
用于控制视频流的呈现方式的选项 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
返回
Promise<void>
注解
此方法是针对复合实现的
getState()
leaveCall(boolean)
离开呼叫
function leaveCall(forEveryone?: boolean): Promise<void>参数
- forEveryone
-
boolean
离开时是否删除所有参与者
返回
Promise<void>
mute()
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("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("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("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("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
offStateChange((state: CallAdapterState) => void)
取消订阅 stateChanged 事件的处理程序。
function offStateChange(handler: (state: CallAdapterState) => void)参数
- handler
-
(state: CallAdapterState) => void
on("callEnded", CallEndedListener)
“callEnded”事件的 Subscribe 函数。
function on(event: "callEnded", listener: CallEndedListener)参数
- event
-
"callEnded"
- listener
- CallEndedListener
on("callIdChanged", CallIdChangedListener)
“callIdChanged”事件的 Subscribe 函数。
function on(event: "callIdChanged", listener: CallIdChangedListener)参数
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
注解
当当前用户的 callId 发生更改时，将触发该事件。
on("diagnosticChanged", DiagnosticChangedEventListner)
“diagnosticChanged”事件的 Subscribe 函数。
每当用户面对有关正在进行的呼叫诊断发生更改时，将触发此事件。
function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)参数
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
on("displayNameChanged", DisplayNameChangedListener)
“displayNameChanged”事件的 Subscribe 函数。
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)参数
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
on("error", (e: AdapterError) => void)
“error”事件的 Subscribe 函数。
function on(event: "error", listener: (e: AdapterError) => void)参数
- event
-
"error"
- listener
-
(e: AdapterError) => void
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
“isLocalScreenSharingActiveChanged”事件的 Subscribe 函数。
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)参数
- event
-
"isLocalScreenSharingActiveChanged"
on("isMutedChanged", IsMutedChangedListener)
“isMutedChanged”事件的 Subscribe 函数。
function on(event: "isMutedChanged", listener: IsMutedChangedListener)参数
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
注解
每当当前用户或远程用户静音状态更改时，都会触发该事件
on("isSpeakingChanged", IsSpeakingChangedListener)
“isSpeakingChanged”事件的 Subscribe 函数。
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)参数
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
on("participantsJoined", ParticipantsJoinedListener)
“participantsJoined”事件的 Subscribe 函数。
function on(event: "participantsJoined", listener: ParticipantsJoinedListener)参数
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
on("participantsLeft", ParticipantsLeftListener)
“participantsLeft”事件的 Subscribe 函数。
function on(event: "participantsLeft", listener: ParticipantsLeftListener)参数
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
on("selectedMicrophoneChanged", PropertyChangedEvent)
“selectedMicrophoneChanged”事件的 Subscribe 函数。
每当用户选择新的麦克风设备时，将触发此事件。
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)参数
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
on("selectedSpeakerChanged", PropertyChangedEvent)
“selectedSpeakerChanged”事件的 Subscribe 函数。
每当用户选择新的扬声器设备时，就会触发此事件。
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)参数
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
onStateChange((state: CallAdapterState) => void)
将处理程序订阅到 stateChanged 事件。
function onStateChange(handler: (state: CallAdapterState) => void)参数
- handler
-
(state: CallAdapterState) => 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 () 之后调用此方法
removeParticipant(string)
从通话中删除参与者。
function removeParticipant(userId: string): Promise<void>参数
- userId
-
string
要删除的参与者的 ID
返回
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>
setMicrophone(AudioDeviceInfo)
设置在通话中使用的麦克风。
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>参数
- sourceInfo
- AudioDeviceInfo
麦克风设备可供选择，选择查询麦克风返回的麦克风设备
返回
Promise<void>
setSpeaker(AudioDeviceInfo)
设置在呼叫中使用的扬声器。
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>参数
- sourceInfo
- AudioDeviceInfo
要选择的扬声器设备，选择 querySpeakers 返回的一个
返回
Promise<void>
startCamera(VideoStreamOptions)
启动相机 此方法将在调用未处于活动状态时开始呈现本地相机视图
function startCamera(options?: VideoStreamOptions): Promise<void>参数
- options
- VideoStreamOptions
用于控制视频流的呈现方式的选项 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
返回
Promise<void>
startScreenShare()
开始在通话期间共享屏幕。
function startScreenShare(): Promise<void>返回
Promise<void>
stopCamera()
停止相机 此方法将在调用未处于活动状态时停止呈现本地相机视图
function stopCamera(): Promise<void>返回
Promise<void>
stopScreenShare()
停止共享屏幕
function stopScreenShare(): Promise<void>返回
Promise<void>
unmute()
呼叫期间取消当前用户的静音或在本地启用麦克风
function unmute(): Promise<void>返回
Promise<void>