视频双流

  • HarmonyOS

更新时间不可用

setDualStreamMode

在发送端设置双流模式并设置视频小流。

TypeScript
public abstract setDualStreamMode(mode: Constants.SimulcastStreamMode, streamConfig?: SimulcastStreamConfig): number;

详情

SDK 默认在发送端开启小流自适应模式 (AUTO),即发送端不主动发送小流,主播身份的接收端可以调用 setRemoteVideoStreamType 发起小流申请,发送端收到申请后开始自动发送小流。

  • 如果你想修改此行为,可以调用该方法并修改 mode 为 DISABLE(始终不发送小流)或 ENABLE(始终发送小流)。
  • 如果你在进行修改后又想恢复该默认行为,可重新调用该方法,并将 mode 设置为 AUTO。

参数

参数名描述
mode

发送视频流的模式。详见 SimulcastStreamMode。

streamConfig

视频小流的配置。详见 SimulcastStreamConfig。

注: 当设置 mode 为 DISABLE 时,再设置 streamConfig 不会生效。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。 详见错误码了解详情和解决建议。

setDualStreamModeEx

在发送端设置双流模式。

TypeScript
public abstract setDualStreamModeEx(mode:Constants.SimulcastStreamMode,streamConfig:SimulcastStreamConfig,connection:RtcConnection):number;

详情

SDK 默认在发送端开启小流自适应模式 (AUTO),即发送端不主动发送小流,主播身份的接收端可以调用 setRemoteVideoStreamTypeEx 发起小流申请,发送端收到申请后开始自动发送小流。

  • 如果你想修改此行为,可以调用该方法并修改 mode 为 DISABLE(始终不发送小流)或 ENABLE(始终发送小流)。
  • 如果你在进行修改后又想恢复该默认行为,可重新调用该方法,并将 mode 设置为 AUTO。

参数

参数名描述
mode

发送视频流的模式。详见 SimulcastStreamMode。

streamConfig

视频小流的配置。详见 SimulcastStreamConfig。

注: 当设置 mode 为 DISABLE 时,再设置 streamConfig 不会生效。

connection

Connection 信息。详见 RtcConnection。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。 详见错误码了解详情和解决建议。

所属接口类

setRemoteDefaultVideoStreamType

设置默认订阅的视频流类型。

TypeScript
public abstract setRemoteDefaultVideoStreamType(streamType: Constants.VideoStreamType): number;

取决于发送端的默认行为和调用 setDualStreamMode 的具体设置,接收端调用该方法分为以下几种情况:

  • SDK 默认在发送端开启小流自适应模式 (AUTO),即:发送端仅发送大流,仅主播身份的接收端可以调用该方法发起小流申请,发送端收到申请后开始自动发送小流,此时频道内所有用户均可调用该方法切换到小流订阅模式。
  • 当发送端调用 setDualStreamMode 并将 mode 设置为 DISABLE(始终不发送小流),则调用该方法不生效。
  • 当发送端调用 setDualStreamMode 并将 mode 设置为 ENABLE(始终发送小流),则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。

在接收视频小流时,SDK 会根据视频窗口的大小动态调整对应视频流的大小,以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比,系统会自动分配小流的分辨率、帧率及码率。

调用时机

该方法只能在加入频道前调用。SDK 不支持你在加入频道后修改默认订阅的视频流类型。

调用限制

如果你既调用了该方法,也调用了 setRemoteVideoStreamType,则 SDK 以 setRemoteVideoStreamType 中的设置为准。

参数

参数名描述
streamType

默认订阅的视频流类型: VideoStreamType。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setRemoteVideoStreamType

设置订阅的视频流类型。

TypeScript
public abstract setRemoteVideoStreamType(uid: number, streamType: Constants.VideoStreamType): number;

详情

取决于发送端的默认行为和调用 setDualStreamMode 的具体设置,接收端调用该方法分为以下几种情况:

  • SDK 默认在发送端开启小流自适应模式 (AUTO),即:发送端仅发送大流,仅主播身份的接收端可以调用该方法发起小流申请,发送端收到申请后开始自动发送小流,此时频道内所有用户均可调用该方法切换到小流订阅模式。
  • 当发送端调用 setDualStreamMode 并将 mode 设置为 DISABLE(始终不发送小流),则调用该方法不生效。
  • 当发送端调用 setDualStreamMode 并将 mode 设置为 ENABLE(始终发送小流),则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。

在接收视频小流时,SDK 会根据视频窗口的大小动态调整对应视频流的大小,以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比,系统会自动分配小流的分辨率、帧率及码率。

注意:

  • 该方法在加入频道前后都能调用。
  • 如果既调用了该方法,也调用了 setRemoteDefaultVideoStreamType,则 SDK 以该方法中的设置为准。

参数

参数名描述
uid

用户 ID。

streamType

视频流类型: VideoStreamType。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

setRemoteVideoStreamTypeEx

设置订阅的视频流类型。

TypeScript
public abstract setRemoteVideoStreamTypeEx(uid:number,streamType:number,connection:RtcConnection):number;

详情

取决于发送端的默认行为和调用 setDualStreamMode 的具体设置,接收端调用该方法分为以下几种情况:

  • SDK 默认在发送端开启小流自适应模式 (AUTO),即:发送端仅发送大流,仅主播身份的接收端可以调用该方法发起小流申请,发送端收到申请后开始自动发送小流,此时频道内所有用户均可调用该方法切换到小流订阅模式。
  • 当发送端调用 setDualStreamMode 并将 mode 设置为 DISABLE(始终不发送小流),则调用该方法不生效。
  • 当发送端调用 setDualStreamMode 并将 mode 设置为 ENABLE(始终发送小流),则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。

在接收视频小流时,SDK 会根据视频窗口的大小动态调整对应视频流的大小,以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比,系统会自动分配小流的分辨率、帧率及码率。

注意:

  • 观众角色的接收端调用该方法不生效。

参数

参数名描述
uid

用户 ID。

streamType

视频流类型: VideoStreamType。

connection

Connection 信息。详见 RtcConnection。

表格内容超出当前宽度,可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类