跳到主要内容

设备管理

提示

以下示例代码中的 room 指加入房间成功后获取到的实例。

操作房间内设备

开启摄像头预览

调用 startPreview 方法开启视频预览。

接口

typescript
room.startPreview()

使用说明

  • 仅在摄像头被打开的情况下有效
  • 该方法为同步方法,无返回值

示例代码

typescript
/**
* 开启视频预览,仅在摄像头被打开的情况下有效
*/
room.startPreview()

关闭摄像头预览

调用 stopPreview 方法关闭视频预览。

接口

typescript
room.stopPreview()

使用说明

  • 仅在摄像头被打开的情况下有效
  • 该方法为同步方法,无返回值

示例代码

typescript
/**
* 关闭视频预览,仅在摄像头被打开的情况下有效
*/
room.stopPreview()

打开摄像头

调用 openCamera 方法打开摄像头。

接口

typescript
room.openCamera(options)

使用说明

  • 未发布视频时,该方法仅打开摄像头硬件设备
  • 发布视频后,打开摄像头硬件设备后,修改视频资源状态为可用,订阅端可以看到发布的视频

示例代码

typescript
/**
* 开启摄像头
* 未发布视频时,该方法仅打开摄像头硬件设备
* 发布音频后,打开麦克风硬件设备后,修改音频资源状态为可用,订阅端可以听到发布的声音
*/
const { code } = await room.openCamera()

关闭摄像头

调用 closeCamera 方法关闭摄像头。

接口

typescript
room.closeCamera()

使用说明

  • 未发布视频时,该方法仅关闭摄像头硬件设备
  • 发布视频后,关闭摄像头硬件设备后,修改视频资源状态为不可用,订阅端看到发布的视频为黑屏

示例代码

typescript
/**
* 关闭摄像头
* 未发布视频时,该方法仅关闭摄像头硬件设备
* 发布视频后,关闭摄像头硬件设备后,修改视频资源状态为不可用,订阅端看到发布的视频为黑屏
*/
const { code } = await room.closeCamera()

打开麦克风

调用 openMicphone 方法打开麦克风。

接口

typescript
room.openMicphone()

使用说明

  • 未发布音频时,该方法仅打开麦克风硬件设备
  • 发布音频后,打开麦克风硬件设备后,修改音频资源状态为可用,订阅端可以听到发布的声音

示例代码

typescript
/**
* 开启麦克风
* 未发布音频时,该方法仅打开麦克风硬件设备
* 发布音频后,打开麦克风硬件设备后,修改音频资源状态为可用,订阅端可以听到发布的声音
*/
const { code } = await room.openMicphone()

关闭麦克风

调用 closeMicphone 方法关闭麦克风。

接口

typescript
room.closeMicphone()

使用说明

  • 未发布音频时,该方法仅关闭麦克风硬件设备
  • 发布音频后,关闭麦克风硬件设备后,修改音频资源状态为不可用,订阅端听不到发布的声音

示例代码

typescript
/**
* 关闭麦克风
* 未发布音频时,该方法仅关闭麦克风硬件设备
* 发布音频后,关闭麦克风硬件设备后,修改音频资源状态为不可用,订阅端听不到发布的声音
*/
const { code } = await room.closeMicphone()

获取房间内设备状态

摄像头是否开启

调用 isCameraOpen 方法判断摄像头是否开启。

接口

typescript
room.isCameraOpen()

示例代码

typescript
/**
* 摄像头是否开启
*/
const isCameraOpen = room.isCameraOpen()

麦克风是否开启

调用 isMicphoneOpen 方法判断麦克风是否开启。

接口

typescript
room.isMicphoneOpen()

示例代码

typescript
/**
* 麦克风是否开启
*/
const isMicphoneOpen = room.isMicphoneOpen()