enableDualStreamModeEx abstract method

Future<void> enableDualStreamModeEx({
  1. required bool enabled,
  2. required SimulcastStreamConfig streamConfig,
  3. required RtcConnection connection,
})

Enables or disables dual-stream mode on the sending end.

Deprecated Deprecated: Deprecated since v4.2.0. Use setDualStreamModeEx instead. You can call this method on the sending end to enable or disable dual-stream mode. Dual-stream refers to high-quality and low-quality video streams: High-quality stream: High resolution and high frame rate video stream. Low-quality stream: Low resolution and low frame rate video stream. After enabling dual-stream mode, you can call setRemoteVideoStreamType on the receiving end to choose whether to receive the high-quality or low-quality stream. This method applies to all types of streams sent by the sender, including but not limited to camera-captured video, screen sharing, and custom-captured video.

  • enabled Whether to enable dual-stream mode: true : Enable dual-stream mode. false : (Default) Disable dual-stream mode.
  • streamConfig Configuration for the low-quality stream. See SimulcastStreamConfig. When mode is set to disableSimulcastStream, setting streamConfig has no effect.
  • connection Connection information. See RtcConnection.

Returns When the method call succeeds, there is no return value; when fails, the AgoraRtcException exception is thrown. You need to catch the exception and handle it accordingly. See Error Codes for details and resolution suggestions.

Implementation

Future<void> enableDualStreamModeEx(
    {required bool enabled,
    required SimulcastStreamConfig streamConfig,
    required RtcConnection connection});