视频双流
enableDualStreamMode [1/2]
在发送端开启或关闭双流模式。
virtual int enableDualStreamMode(bool enabled) = 0;
详情
- 视频大流:高分辨率、高帧率的视频流。
- 视频小流:低分辨率、低帧率的视频流。
开启双流模式后,你可以在收流端调用 setRemoteVideoStreamType 选择接收视频大流或视频小流。
- 该方法适用于发送端发送的所有类型的流,包括且不限于来自摄像头采集的视频流、屏幕共享流、自定义采集的视频流。
- 如果需要在多频道场景下开启视频双流,可以调用 enableDualStreamModeEx 方法。
- 该方法可以在加入频道前后调用。
参数
- enabled
- 是否开启双流模式。
true
: 开启双流模式。false
: (默认) 关闭双流模式。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。详见错误码了解详情和解决建议。
enableDualStreamMode [2/2]
在发送端开启或关闭双流模式并设置视频小流。
virtual int enableDualStreamMode(bool enabled, const SimulcastStreamConfig& streamConfig) = 0;
详情
- 视频大流:高分辨率、高帧率的视频流。
- 视频小流:低分辨率、低帧率的视频流。
开启双流模式后,你可以在收流端调用 setRemoteVideoStreamType 选择接收视频大流或视频小流。
- 该方法适用于发送端发送的所有类型的流,包括且不限于来自摄像头采集的视频流、屏幕共享流、自定义采集的视频流。
- 如果需要在多频道场景下开启视频双流,可以调用 enableDualStreamModeEx 方法。
- 该方法可以在加入频道前后调用。
参数
- enabled
- 是否开启双流模式:
true
: 开启双流模式。false
: (默认) 关闭双流模式。
- streamConfig
视频小流的配置。详见 SimulcastStreamConfig。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。 详见错误码了解详情和解决建议。
enableDualStreamModeEx
在发送端开启或关闭双流模式。
virtual int enableDualStreamModeEx(bool enabled, const SimulcastStreamConfig& streamConfig,
const RtcConnection& connection) = 0;
详情
- 视频大流:高分辨率、高帧率的视频流。
- 视频小流:低分辨率、低帧率的视频流。
开启双流模式后,你可以在收流端调用 setRemoteVideoStreamType 选择接收视频大流或视频小流。
参数
- enabled
- 是否开启双流模式:
true
: 开启双流模式。false
: (默认) 关闭双流模式。
- streamConfig
视频小流的配置。详见 SimulcastStreamConfig。
- connection
- Connection 信息。详见 RtcConnection。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。 详见错误码了解详情和解决建议。
setDualStreamMode [1/2]
在发送端设置双流模式。
virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode) = 0;
详情
- 如果你想修改此行为,可以调用该方法并修改 mode 为 DISABLE_SIMULCAST_STREAM(始终不发送小流)或 ENABLE_SIMULCAST_STREAM(始终发送小流)。
- 如果你在进行修改后又想恢复该默认行为,可重新调用该方法,并将 mode 设置为 AUTO_SIMULCAST_STREAM。
- 调用该方法并设置 mode 为 DISABLE_SIMULCAST_STREAM 时,跟 enableDualStreamMode [1/2]
(false)
的效果相同。 - 调用该方法并设置 mode 为 ENABLE_SIMULCAST_STREAM 时,跟 enableDualStreamMode [1/2]
(true)
的效果相同。 - 两种方法均可在加入频道前后调用,若同时使用,则以后调用的方法中的设置为准。
参数
- mode
- 发送视频流的模式。详见 SIMULCAST_STREAM_MODE。
返回值
- 0:方法调用成功。
- < 0:方法调用失败。详见错误码了解详情和解决建议。
setDualStreamMode [2/2]
在发送端设置双流模式并设置视频小流。
virtual int setDualStreamMode(SIMULCAST_STREAM_MODE mode,
const SimulcastStreamConfig& streamConfig) = 0;
详情
- 如果你想修改此行为,可以调用该方法并修改 mode 为 DISABLE_SIMULCAST_STREAM(始终不发送小流)或 ENABLE_SIMULCAST_STREAM(始终发送小流)。
- 如果你在进行修改后又想恢复该默认行为,可重新调用该方法,并将 mode 设置为 AUTO_SIMULCAST_STREAM。
该方法跟 setDualStreamMode [1/2] 的区别在于,该方法还可以进行视频小流的配置,SDK 会根据 streamConfig 中的配置发送小流。
- 调用该方法并设置 mode 为 DISABLE_SIMULCAST_STREAM 时,跟调用 enableDualStreamMode [2/2] 并设置 enabled 为
false
的效果相同。 - 调用该方法并设置 mode 为 ENABLE_SIMULCAST_STREAM 时,跟调用 enableDualStreamMode [2/2] 并设置 enabled 为
true
的效果相同。 - 两种方法均可在加入频道前后调用,若同时使用,则以后调用的方法中的设置为准。
参数
- mode
- 发送视频流的模式。详见 SIMULCAST_STREAM_MODE。
- streamConfig
视频小流的配置。详见 SimulcastStreamConfig。
警告- 当设置 mode 为 DISABLE_SIMULCAST_STREAM 时,再设置 streamConfig 不会生效。
- 务必设置 streamConfig 中的各项参数,否则该方法不会生效。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。 详见错误码了解详情和解决建议。
setDualStreamModeEx
在发送端设置双流模式。
virtual int setDualStreamModeEx(SIMULCAST_STREAM_MODE mode,
const SimulcastStreamConfig& streamConfig,
const RtcConnection& connection) = 0;
详情
SDK 默认在发送端开启小流 auto 模式,效果等同于调用该方法并将 mode 设置为 AUTO_SIMULCAST_STREAM。如果你想修改此行为,可以调用该方法并修改 mode 为 DISABLE_SIMULCAST_STREAM(始终不发送小流)或 ENABLE_SIMULCAST_STREAM(始终发送小流)。
- 调用该方法并设置 mode 为 DISABLE_SIMULCAST_STREAM 时,跟 enableDualStreamModeEx
(false)
的效果相同。 - 调用该方法并设置 mode 为 ENABLE_SIMULCAST_STREAM 时,跟 enableDualStreamModeEx
(true)
的效果相同。 - 两种方法均可在加入频道前后调用,若同时使用,则以后调用的方法中的设置为准。
参数
- mode
- 发送视频流的模式。详见 SIMULCAST_STREAM_MODE。
- streamConfig
视频小流的配置。详见 SimulcastStreamConfig。
- connection
- Connection 信息。详见 RtcConnection。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。 详见错误码了解详情和解决建议。
setRemoteDefaultVideoStreamType
设置默认订阅的视频流类型。
virtual int setRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE streamType) = 0;
详情
在网络条件受限的情况下,如果发送端没有调用 enableDualStreamMode [2/2](false)
关闭双流模式,接收端可以选择接收大流还是小流。其中,大流为高分辨率高码率的视频流,小流则是低分辨率低码率的视频流。
正常情况下,用户默认接收大流。如需默认接收所有用户的视频小流,可以调用本方法进行切换。SDK 会根据视频窗口的大小动态调整对应视频流的大小,以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比,系统会自动分配小流的分辨率、帧率及码率。
SDK 默认在发送端开启小流 auto 模式(不主动发送小流),主播身份的接收端可以调用本方法在接收端发起小流申请(观众角色的接收端调用该方法不生效),发送端收到申请后自动切换为小流模式。
- 该方法只能在加入频道前调用。SDK 不支持你在加入频道后修改默认订阅的视频流类型。
- 如果你既调用了该方法,也调用了 setRemoteVideoStreamType,则 SDK 以 setRemoteVideoStreamType 中的设置为准。
参数
- streamType
默认订阅的视频流类型: VIDEO_STREAM_TYPE。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setRemoteVideoStreamType
设置订阅的视频流类型。
virtual int setRemoteVideoStreamType(uid_t uid, VIDEO_STREAM_TYPE streamType) = 0;
详情
在网络条件受限的情况下,如果发送端没有调用 enableDualStreamMode [2/2](false)
关闭双流模式,接收端可以调用该方法选择接收大流还是小流。其中,大流为高分辨率高码率的视频流,小流则是低分辨率低码率的视频流。
正常情况下,用户默认接收大流。如需接收小流,可以调用本方法进行切换。SDK 会根据视频窗口的大小动态调整对应视频流的大小,以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比,系统会自动分配小流的分辨率、帧率及码率。
SDK 默认在发送端开启小流 auto 模式(不主动发送小流),主播身份的接收端可以调用本方法在接收端发起小流申请(观众角色的接收端调用该方法不生效),发送端收到申请后自动切换为小流模式。
参数
- uid
- 用户 ID。
- streamType
视频流类型: VIDEO_STREAM_TYPE。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setRemoteVideoStreamTypeEx
设置订阅的视频流类型。
virtual int setRemoteVideoStreamTypeEx(uid_t uid, VIDEO_STREAM_TYPE streamType, const RtcConnection& connection) = 0;
详情
在网络条件受限的情况下,如果发送端没有调用 enableDualStreamModeEx(false)
关闭双流模式,接收端可以调用该方法选择接收大流还是小流。其中,大流为高分辨率高码率的视频流,小流则是低分辨率低码率的视频流。
正常情况下,用户默认接收大流。如需接收小流,可以调用本方法进行切换。SDK 会根据视频窗口的大小动态调整对应视频流的大小,以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比,系统会自动分配小流的分辨率、帧率及码率。
SDK 默认在发送端开启小流 auto 模式(不主动发送小流),接收端主播可以调用本方法在接收端发起小流申请,发送端收到申请后自动切换为小流模式。
参数
- uid
- 用户 ID。
- streamType
视频流类型: VIDEO_STREAM_TYPE。
- connection
- Connection 信息。详见 RtcConnection。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。