视频双流
enableDualStreamMode:
在发送端开启或关闭双流模式。
Objective-C
- (int)enableDualStreamMode:(BOOL)enabled;
详情
废弃
双流指视频大流和视频小流：
- 视频大流：高分辨率、高帧率的视频流。
- 视频小流：低分辨率、低帧率的视频流。
开启双流模式后，你可以在收流端调用 setRemoteVideoStream:type: 选择接收视频大流或视频小流。
信息
- 该方法适用于发送端发送的所有类型的流，包括且不限于来自摄像头采集的视频流、屏幕共享流、自定义采集的视频流。
- 如果需要在多频道场景下开启视频双流，可以调用 enableDualStreamModeEx:streamConfig:connection: 方法。
- 该方法可以在加入频道前后调用。
参数
- enabled
- 是否开启双流模式。
YES: 开启双流模式。NO: (默认) 关闭双流模式。
返回值
- 0：方法调用成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
enableDualStreamMode:streamConfig:
在发送端开启或关闭双流模式并设置视频小流。
Objective-C
- (int)enableDualStreamMode:(BOOL)enabled
streamConfig:(AgoraSimulcastStreamConfig* _Nonnull)streamConfig;
详情
废弃
你可以在发流端调用该方法开启或关闭双流模式。双流指视频大流和视频小流：
- 视频大流：高分辨率、高帧率的视频流。
- 视频小流：低分辨率、低帧率的视频流。
开启双流模式后，你可以在收流端调用 setRemoteVideoStream:type: 选择接收视频大流或视频小流。
信息
- 该方法适用于发送端发送的所有类型的流，包括且不限于来自摄像头采集的视频流、屏幕共享流、自定义采集的视频流。
- 如果需要在多频道场景下开启视频双流，可以调用 enableDualStreamModeEx:streamConfig:connection: 方法。
- 该方法可以在加入频道前后调用。
参数
- enabled
- 是否开启双流模式：
YES: 开启双流模式。NO: (默认) 关闭双流模式。
- streamConfig
- 视频小流的配置。详见 AgoraSimulcastStreamConfig。信息当设置 mode 为 AgoraDisableSimulcastStream 时，再设置 streamConfig 不会生效。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。 详见错误码了解详情和解决建议。
enableDualStreamModeEx:streamConfig:connection:
在发送端开启或关闭双流模式。
Objective-C
- (int)enableDualStreamModeEx:(BOOL)enabled
streamConfig:(AgoraSimulcastStreamConfig*)streamConfig
connection:(AgoraRtcConnection* _Nonnull)connection;
详情
自从
v4.0.1
废弃
你可以在发流端调用该方法开启或关闭双流模式。双流指视频大流和视频小流：
- 视频大流：高分辨率、高帧率的视频流。
- 视频小流：低分辨率、低帧率的视频流。
开启双流模式后，你可以在收流端调用 setRemoteVideoStream:type: 选择接收视频大流或视频小流。
信息
该方法适用于发送端发送的所有类型的流，包括且不限于来自摄像头采集的视频流、屏幕共享流、自定义采集的视频流。
参数
- enabled
- 是否开启双流模式：
YES: 开启双流模式。NO: (默认) 关闭双流模式。
- streamConfig
- 视频小流的配置。详见 AgoraSimulcastStreamConfig。信息当设置 mode 为 AgoraDisableSimulcastStream 时，再设置 streamConfig 不会生效。
- connection
- Connection 信息。详见 AgoraRtcConnection。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。 详见错误码了解详情和解决建议。
setDualStreamMode:
在发送端设置双流模式。
Objective-C
- (int)setDualStreamMode:(AgoraSimulcastStreamMode)mode;
详情
自从
v4.0.1
SDK 默认在发送端开启小流自适应模式 (AgoraAutoSimulcastStream)，即发送端不主动发送小流，主播身份的接收端可以调用 setRemoteVideoStream:type: 发起小流申请，发送端收到申请后开始自动发送小流。
- 如果你想修改此行为，可以调用该方法并修改 mode 为 AgoraDisableSimulcastStream（始终不发送小流）或 AgoraEnableSimulcastStream（始终发送小流）。
- 如果你在进行修改后又想恢复该默认行为，可重新调用该方法，并将 mode 设置为 AgoraAutoSimulcastStream。
信息
该方法和 enableDualStreamMode: 的区别与联系如下：
- 调用该方法并设置 mode 为 AgoraDisableSimulcastStream 时，跟 enableDualStreamMode:
(NO)的效果相同。 - 调用该方法并设置 mode 为 AgoraEnableSimulcastStream 时，跟 enableDualStreamMode:
(YES)的效果相同。 - 两种方法均可在加入频道前后调用，若同时使用，则以后调用的方法中的设置为准。
参数
- mode
- 发送视频流的模式。详见 AgoraSimulcastStreamMode。
返回值
- 0：方法调用成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
setDualStreamMode:streamConfig:
在发送端设置双流模式并设置视频小流。
Objective-C
- (int)setDualStreamMode:(AgoraSimulcastStreamMode)mode
streamConfig:(AgoraSimulcastStreamConfig* _Nonnull)streamConfig;
详情
自从
v4.0.1
SDK 默认在发送端开启小流自适应模式 (AgoraAutoSimulcastStream)，即发送端不主动发送小流，主播身份的接收端可以调用 setRemoteVideoStream:type: 发起小流申请，发送端收到申请后开始自动发送小流。
- 如果你想修改此行为，可以调用该方法并修改 mode 为 AgoraDisableSimulcastStream（始终不发送小流）或 AgoraEnableSimulcastStream（始终发送小流）。
- 如果你在进行修改后又想恢复该默认行为，可重新调用该方法，并将 mode 设置为 AgoraAutoSimulcastStream。
该方法跟 setDualStreamMode: 的区别在于，该方法还可以进行视频小流的配置，SDK 会根据 streamConfig 中的配置发送小流。
信息
该方法和 enableDualStreamMode:streamConfig: 的区别与联系如下：
- 调用该方法并设置 mode 为 AgoraDisableSimulcastStream 时，跟调用 enableDualStreamMode:streamConfig: 并设置 enabled 为
NO的效果相同。 - 调用该方法并设置 mode 为 AgoraEnableSimulcastStream 时，跟调用 enableDualStreamMode:streamConfig: 并设置 enabled 为
YES的效果相同。 - 两种方法均可在加入频道前后调用，若同时使用，则以后调用的方法中的设置为准。
参数
- mode
- 发送视频流的模式。详见 AgoraSimulcastStreamMode。
- streamConfig
- 视频小流的配置。详见 AgoraSimulcastStreamConfig。信息当设置 mode 为 AgoraDisableSimulcastStream 时，再设置 streamConfig 不会生效。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。 详见错误码了解详情和解决建议。
setDualStreamModeEx:streamConfig:connection:
在发送端设置双流模式。
Objective-C
- (int)setDualStreamModeEx:(AgoraSimulcastStreamMode)mode
streamConfig:(AgoraSimulcastStreamConfig*)streamConfig
connection:(AgoraRtcConnection* _Nonnull)connection;
详情
自从
v4.0.1
SDK 默认在发送端开启小流自适应模式 (AgoraAutoSimulcastStream)，即发送端不主动发送小流，主播身份的接收端可以调用 setRemoteVideoStreamEx:type:connection: 发起小流申请，发送端收到申请后开始自动发送小流。
- 如果你想修改此行为，可以调用该方法并修改 mode 为 AgoraDisableSimulcastStream（始终不发送小流）或 AgoraEnableSimulcastStream（始终发送小流）。
- 如果你在进行修改后又想恢复该默认行为，可重新调用该方法，并将 mode 设置为 AgoraAutoSimulcastStream。
信息
该方法和 enableDualStreamModeEx:streamConfig:connection: 的区别与联系如下：
- 调用该方法并设置 mode 为 AgoraDisableSimulcastStream 时，跟 enableDualStreamModeEx:streamConfig:connection:
(NO)的效果相同。 - 调用该方法并设置 mode 为 AgoraEnableSimulcastStream 时，跟 enableDualStreamModeEx:streamConfig:connection:
(YES)的效果相同。 - 两种方法均可在加入频道前后调用，若同时使用，则以后调用的方法中的设置为准。
参数
- mode
- 发送视频流的模式。详见 AgoraSimulcastStreamMode。
- streamConfig
- 视频小流的配置。详见 AgoraSimulcastStreamConfig。信息当设置 mode 为 AgoraDisableSimulcastStream 时，再设置 streamConfig 不会生效。
- connection
- Connection 信息。详见 AgoraRtcConnection。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。 详见错误码了解详情和解决建议。
setRemoteDefaultVideoStreamType:
设置默认订阅的视频流类型。
Objective-C
- (int)setRemoteDefaultVideoStreamType:(AgoraVideoStreamType)streamType;
取决于发送端的默认行为和调用 setDualStreamMode:streamConfig: 的具体设置，接收端调用该方法分为以下几种情况：
- SDK 默认在发送端开启小流自适应模式 (AgoraAutoSimulcastStream)，即：发送端仅发送大流，仅主播身份的接收端可以调用该方法发起小流申请，发送端收到申请后开始自动发送小流，此时频道内所有用户均可调用该方法切换到小流订阅模式。
- 当发送端调用 setDualStreamMode:streamConfig: 并将 mode 设置为 AgoraDisableSimulcastStream（始终不发送小流），则调用该方法不生效。
- 当发送端调用 setDualStreamMode:streamConfig: 并将 mode 设置为 AgoraEnableSimulcastStream（始终发送小流），则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。
在接收视频小流时，SDK 会根据视频窗口的大小动态调整对应视频流的大小，以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比，系统会自动分配小流的分辨率、帧率及码率。
调用时机
该方法只能在加入频道前调用。SDK 不支持你在加入频道后修改默认订阅的视频流类型。
调用限制
如果你既调用了该方法，也调用了 setRemoteVideoStream:type:，则 SDK 以 setRemoteVideoStream:type: 中的设置为准。
参数
- streamType
默认订阅的视频流类型: AgoraVideoStreamType。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setRemoteVideoStream:type:
设置订阅的视频流类型。
Objective-C
- (int)setRemoteVideoStream:(NSUInteger)uid
type:(AgoraVideoStreamType)streamType;
详情
取决于发送端的默认行为和调用 setDualStreamMode:streamConfig: 的具体设置，接收端调用该方法分为以下几种情况：
- SDK 默认在发送端开启小流自适应模式 (AgoraAutoSimulcastStream)，即：发送端仅发送大流，仅主播身份的接收端可以调用该方法发起小流申请，发送端收到申请后开始自动发送小流，此时频道内所有用户均可调用该方法切换到小流订阅模式。
- 当发送端调用 setDualStreamMode:streamConfig: 并将 mode 设置为 AgoraDisableSimulcastStream（始终不发送小流），则调用该方法不生效。
- 当发送端调用 setDualStreamMode:streamConfig: 并将 mode 设置为 AgoraEnableSimulcastStream（始终发送小流），则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。
在接收视频小流时，SDK 会根据视频窗口的大小动态调整对应视频流的大小，以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比，系统会自动分配小流的分辨率、帧率及码率。
注意
- 该方法在加入频道前后都能调用。
- 如果既调用了该方法，也调用了 setRemoteDefaultVideoStreamType:，则 SDK 以该方法中的设置为准。
参数
- uid
- 用户 ID。
- streamType
视频流类型: AgoraVideoStreamType。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
setRemoteVideoStreamEx:type:connection:
设置订阅的视频流类型。
Objective-C
- (int)setRemoteVideoStreamEx:(NSUInteger)uid
type:(AgoraVideoStreamType)streamType
connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(setRemoteVideoStreamEx(_:type:connection:));
详情
取决于发送端的默认行为和调用 setDualStreamMode:streamConfig: 的具体设置，接收端调用该方法分为以下几种情况：
- SDK 默认在发送端开启小流自适应模式 (AgoraAutoSimulcastStream)，即：发送端仅发送大流，仅主播身份的接收端可以调用该方法发起小流申请，发送端收到申请后开始自动发送小流，此时频道内所有用户均可调用该方法切换到小流订阅模式。
- 当发送端调用 setDualStreamMode:streamConfig: 并将 mode 设置为 AgoraDisableSimulcastStream（始终不发送小流），则调用该方法不生效。
- 当发送端调用 setDualStreamMode:streamConfig: 并将 mode 设置为 AgoraEnableSimulcastStream（始终发送小流），则主播或观众身份的接收端均可调用该方法切换到小流订阅模式。
在接收视频小流时，SDK 会根据视频窗口的大小动态调整对应视频流的大小，以节约带宽和计算资源。视频小流默认的宽高比和视频大流的宽高比一致。根据当前大流的宽高比，系统会自动分配小流的分辨率、帧率及码率。
注意
- 如果发送端已调用 setDualStreamModeEx:streamConfig:connection: 并将 mode 设置为 AgoraDisableSimulcastStream（始终不发送小流），则调用该方法不生效，你需要在发送端重新调用 setDualStreamModeEx:streamConfig:connection: 修改设置。
- 观众角色的接收端调用该方法不生效。
参数
- uid
- 用户 ID。
- streamType
视频流类型: AgoraVideoStreamType。
- connection
- Connection 信息。详见 AgoraRtcConnection。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。