你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

CallAdapterCallManagement interface

警告

现已弃用此 API。

CallAdapter interface will be flatten, consider using CallAdapter directly

用于管理当前呼叫或开始新呼叫的功能

Extends

方法

joinCall(boolean)

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

startCall(string[], StartCallOptions)

启动呼叫。

继承的方法

createStreamView(string, VideoStreamOptions)

为流创建 html 视图。

disposeStreamView(string, VideoStreamOptions)

释放流的 html 视图。

leaveCall(boolean)

离开呼叫

mute()

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

removeParticipant(string)

从通话中删除参与者。

startCamera(VideoStreamOptions)

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

startScreenShare()

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

stopCamera()

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

stopScreenShare()

停止共享屏幕

unmute()

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

方法详细信息

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 数组

返回

undefined | Call

继承的方法详细信息

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>

注解

此方法是针对复合实现的

继承自CallAdapterCallOperations.createStreamView

disposeStreamView(string, VideoStreamOptions)

释放流的 html 视图。

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

参数

remoteUserId

string

要呈现的参与者的 ID,将其保留为未定义以释放本地相机视图

options
VideoStreamOptions

用于控制视频流的呈现方式的选项 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

返回

Promise<void>

注解

此方法是针对复合实现的

继承自CallAdapterCallOperations.disposeStreamView

leaveCall(boolean)

离开呼叫

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

参数

forEveryone

boolean

离开时是否删除所有参与者

返回

Promise<void>

继承自CallAdapterCallOperations.leaveCall

mute()

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

function mute(): Promise<void>

返回

Promise<void>

继承自CallAdapterCallOperations.mute

removeParticipant(string)

从通话中删除参与者。

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

参数

userId

string

要删除的参与者的 ID

返回

Promise<void>

继承自CallAdapterCallOperations.removeParticipant

startCamera(VideoStreamOptions)

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

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

参数

options
VideoStreamOptions

用于控制视频流的呈现方式的选项 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

返回

Promise<void>

继承自CallAdapterCallOperations.startCamera

startScreenShare()

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

function startScreenShare(): Promise<void>

返回

Promise<void>

继承自CallAdapterCallOperations.startScreenShare

stopCamera()

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

function stopCamera(): Promise<void>

返回

Promise<void>

继承自CallAdapterCallOperations.stopCamera

stopScreenShare()

停止共享屏幕

function stopScreenShare(): Promise<void>

返回

Promise<void>

继承自CallAdapterCallOperations.stopScreenShare

unmute()

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

function unmute(): Promise<void>

返回

Promise<void>

继承自CallAdapterCallOperations.unmute