CommonCallAdapter interface

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

function joinCall(microphoneOn?: boolean)

参数

开始调用。

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

参数

请求设备的权限。

function askDevicePermission(constrain: PermissionConstraints): Promise<void>

参数

返回

注解

如果尚未授予权限，将弹出浏览器权限窗口

继承自CallAdapterDeviceManagement.askDevicePermission

为流创建 html 视图。

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

参数

返回

注解

此方法是针对复合实现的

继承自CallAdapterCallOperations.createStreamView

释放复合

function dispose()

继承自一次性.dispose

释放流的 html 视图。

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

参数

返回

注解

此方法是针对复合实现的

继承自CallAdapterCallOperations.disposeStreamView

获取当前状态

function getState(): CallAdapterState

返回

继承自AdapterState.getState

离开呼叫

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

参数

返回

继承自CallAdapterCallOperations.leaveCall

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

function mute(): Promise<void>

返回

继承自CallAdapterCallOperations.mute

取消订阅“callEnded”事件的函数。

function off(event: "callEnded", listener: CallEndedListener)

参数

继承自CallAdapterSubscribers.off

取消订阅“callIdChanged”事件的函数。

function off(event: "callIdChanged", listener: CallIdChangedListener)

参数

继承自CallAdapterSubscribers.off

取消订阅“diagnosticChanged”事件的函数。

function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

参数

继承自CallAdapterSubscribers.off

取消订阅“displayNameChanged”事件的函数。

function off(event: "displayNameChanged", listener: DisplayNameChangedListener)

参数

继承自CallAdapterSubscribers.off

取消订阅“error”事件的函数。

function off(event: "error", listener: (e: AdapterError) => void)

参数

继承自CallAdapterSubscribers.off

取消订阅“isLocalScreenSharingActiveChanged”事件的函数。

function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

参数

继承自CallAdapterSubscribers.off

取消订阅“isMutedChanged”事件的函数。

function off(event: "isMutedChanged", listener: IsMutedChangedListener)

参数

继承自CallAdapterSubscribers.off

取消订阅“isSpeakingChanged”事件的函数。

function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

参数

继承自CallAdapterSubscribers.off

取消订阅“participantsJoined”事件的函数。

function off(event: "participantsJoined", listener: ParticipantsJoinedListener)

参数

继承自CallAdapterSubscribers.off

取消订阅“participantsLeft”事件的函数。

function off(event: "participantsLeft", listener: ParticipantsLeftListener)

参数

继承自CallAdapterSubscribers.off

取消订阅“selectedMicrophoneChanged”事件的函数。

function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

参数

继承自CallAdapterSubscribers.off

取消订阅“selectedSpeakerChanged”事件的函数。

function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

参数

继承自CallAdapterSubscribers.off

取消订阅 stateChanged 事件的处理程序。

function offStateChange(handler: (state: CallAdapterState) => void)

参数

继承自AdapterState.offStateChange

“callEnded”事件的 Subscribe 函数。

function on(event: "callEnded", listener: CallEndedListener)

参数

继承自CallAdapterSubscribers.on

“callIdChanged”事件的 Subscribe 函数。

function on(event: "callIdChanged", listener: CallIdChangedListener)

参数

注解

当当前用户的 callId 发生更改时，将触发 该事件。

继承自CallAdapterSubscribers.on

“diagnosticChanged”事件的 Subscribe 函数。

每当针对正在进行的调用的用户诊断发生更改时，将触发此事件。

function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

参数

继承自CallAdapterSubscribers.on

“displayNameChanged”事件的 Subscribe 函数。

function on(event: "displayNameChanged", listener: DisplayNameChangedListener)

参数

继承自CallAdapterSubscribers.on

“error”事件的 Subscribe 函数。

function on(event: "error", listener: (e: AdapterError) => void)

参数

继承自CallAdapterSubscribers.on

“isLocalScreenSharingActiveChanged”事件的 Subscribe 函数。

function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

参数

继承自CallAdapterSubscribers.on

“isMutedChanged”事件的 Subscribe 函数。

function on(event: "isMutedChanged", listener: IsMutedChangedListener)

参数

注解

每当当前用户或远程用户静音状态更改时，都会触发该事件

继承自CallAdapterSubscribers.on

“isSpeakingChanged”事件的 Subscribe 函数。

function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

参数

继承自CallAdapterSubscribers.on

“participantsJoined”事件的 Subscribe 函数。

function on(event: "participantsJoined", listener: ParticipantsJoinedListener)

参数

继承自CallAdapterSubscribers.on

“participantsLeft”事件的 Subscribe 函数。

function on(event: "participantsLeft", listener: ParticipantsLeftListener)

参数

继承自CallAdapterSubscribers.on

“selectedMicrophoneChanged”事件的 Subscribe 函数。

每当用户选择新的麦克风设备时，将触发此事件。

function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

参数

继承自CallAdapterSubscribers.on

“selectedSpeakerChanged”事件的 Subscribe 函数。

每当用户选择新的扬声器设备时，就会触发此事件。

function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

参数

继承自CallAdapterSubscribers.on

将处理程序订阅到 stateChanged 事件。

function onStateChange(handler: (state: CallAdapterState) => void)

参数

继承自AdapterState.onStateChange

查询可用的相机设备。

function queryCameras(): Promise<VideoDeviceInfo[]>

返回

视频设备信息实体的数组 <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

注解

应在 askDevicePermission () 之后调用此方法

继承自CallAdapterDeviceManagement.queryCameras

查询可用的麦克风设备。

function queryMicrophones(): Promise<AudioDeviceInfo[]>

返回

音频设备信息实体的数组 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

注解

应在 askDevicePermission () 之后调用此方法

继承自CallAdapterDeviceManagement.queryMicrophones

查询可用的麦克风设备。

function querySpeakers(): Promise<AudioDeviceInfo[]>

返回

音频设备信息实体的数组 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

注解

应在 askDevicePermission () 之后调用此方法

继承自CallAdapterDeviceManagement.querySpeakers

从通话中删除参与者。

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

参数

返回

继承自CallAdapterCallOperations.removeParticipant

设置在调用中使用的相机。

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

参数

返回

继承自CallAdapterDeviceManagement.setCamera

设置在通话中使用的麦克风。

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

参数

返回

继承自CallAdapterDeviceManagement.setMicrophone

设置在通话中使用的扬声器。

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

参数

返回

继承自CallAdapterDeviceManagement.setSpeaker

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

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

参数

返回

继承自CallAdapterCallOperations.startCamera

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

function startScreenShare(): Promise<void>

返回

继承自CallAdapterCallOperations.startScreenShare

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

function stopCamera(): Promise<void>

返回

继承自CallAdapterCallOperations.stopCamera

停止共享屏幕

function stopScreenShare(): Promise<void>

返回

继承自CallAdapterCallOperations.stopScreenShare

在通话期间取消当前用户的静音或在本地启用麦克风

function unmute(): Promise<void>

返回

继承自CallAdapterCallOperations.unmute