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

CallAdapterCallOperations interface

  • 参考
包:
@azure/communication-react

用于管理当前呼叫的功能。

方法

createStreamView(string, VideoStreamOptions)

为流创建 html 视图。
disposeStreamView(string, VideoStreamOptions)

释放流的 html 视图。
leaveCall(boolean)

离开呼叫
mute()

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

从通话中删除参与者。
startCamera(VideoStreamOptions)

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

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

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

停止共享屏幕
unmute()

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

方法详细信息

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>

注解

此方法是针对复合实现的

disposeStreamView(string, VideoStreamOptions)

释放流的 html 视图。

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

参数

remoteUserId

string

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

options
VideoStreamOptions

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

返回

Promise<void>

注解

此方法是针对复合实现的

leaveCall(boolean)

离开呼叫

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

参数

forEveryone

boolean

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

返回

Promise<void>

mute()

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

function mute(): Promise<void>

返回

Promise<void>

removeParticipant(string)

从通话中删除参与者。

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

参数

userId

string

要删除的参与者的 ID

返回

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>