setLocalVideoConfig abstract method

Future<int> setLocalVideoConfig(
  1. NERtcVideoConfig videoConfig,
  2. {int streamType = NERtcVideoStreamType.main}
)

设置视频编码属性。通过此接口可以设置视频主流或辅流的编码分辨率、裁剪模式、码率、帧率、带宽受限时的视频编码降级偏好、编码的镜像模式、编码的方向模式参数。

调用时机

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

说明

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

  • 设置成功后,下一次开启本端视频时生效。

  • 每个属性对应一套视频参数,例如分辨率、帧率、码率等。所有设置的参数均为理想情况下的最大值。当视频引擎因网络环境等原因无法达到设置的分辨率、帧率或码率的最大值时,会取最接近最大值的那个值。

  • 此接口为全量参数配置接口,重复调用此接口时,SDK 会刷新此前的所有参数配置,以最新的传参为准。所以每次修改配置时都需要设置所有参数,未设置的参数将取默认值。

参数说明

config 视频编码属性配置 ,详细信息请参考 NERtcVideoConfig

streamType视频通道类型: * main(0):主流。 * sub(1):辅流。

返回值

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

Implementation

Future<int> setLocalVideoConfig(NERtcVideoConfig videoConfig,
    {int streamType = NERtcVideoStreamType.main});