setCameraCaptureConfig abstract method

Future<int> setCameraCaptureConfig(
  1. NERtcCameraCaptureConfig captureConfig, {
  2. int streamType = NERtcVideoStreamType.main,
})

设置本地摄像头的采集偏好等配置。

通过此接口可以设置本地摄像头采集的主流视频宽度、高度、旋转角度等。

调用时机

请在初始化后调用该方法，且该方法在加入房间前后均可调用。

业务场景

在视频通话或直播中，SDK 自动控制摄像头的输出参数。默认情况下，SDK 会根据用户该接口的配置匹配最合适的分辨率进行采集。但是在部分业务场景中，如果采集画面质量无法满足实际需求，可以调用该接口调整摄像头的采集配置。

说明

  • 纯音频 SDK 禁用该接口，如需使用请前往云信官网下载并替换成视频 SDK。

  • 该方法支持在加入房间后动态调用，设置成功后，会自动重启摄像头采集模块。

  • 若系统相机不支持您设置的分辨率，会自动调整为最相近一档的分辨率，因此建议您设置为常规标准的分辨率。

  • 设置较高的采集分辨率会增加性能消耗，例如 CPU 和内存占用等，尤其是在开启视频前处理的场景下。

  • 在视频通话或直播中，SDK 自动控制摄像头的输出参数。默认情况下，SDK 根据用户的 setLocalVideoConfig 配置匹配最合适的分辨率进行采集。但是在部分业务场景中，如果采集画面质量无法满足实际需求，可以调用该接口调整摄像头的采集配置。

  • 需要采集并预览高清画质时，可以通过参数 NERtcCameraCapturePreference 将采集偏好设置为 kQuality，此时 SDK 会自动设置较高的摄像头输出参数，本地采集与预览画面比编码参数更加清晰。

  • 需要自定义设置摄像头采集的视频尺寸时，请通过参数 NERtcCameraCapturePreference 将采集偏好设为 kManual，并通过 NERtcCameraCaptureConfig 中的 captureWidth 和 captureHeight 自定义设置本地摄像头采集的视频宽高。

参数说明

captureConfig 本地摄像头采集配置，详情请参见NERtcCameraCaptureConfig。 streamType 视频通道类型：

  • main：主流
  • sub：辅流

返回值

  • 0（OK）：方法调用成功。
  • 其他：方法调用失败。
    • 30003（invalidParam)：参数错误，比如 videoConfig 设置为空。
    • 30005（invalidState)：状态错误，比如引擎尚未初始化。
    • 30004（notSupported）：不支持的操作，比如当前使用的是纯音频 SDK。

Implementation

Future<int> setCameraCaptureConfig(NERtcCameraCaptureConfig captureConfig,
    {int streamType = NERtcVideoStreamType.main});