Multipath network transmission

• A mobile device running Android 7.0 (API level 24) or later, with two or more active network connections.

• A mobile device running iOS 12.0 or later, with two or more active network connections.

• A device running macOS with two or more active network connections.

• A Windows device running Vista or later, with two or more active network interfaces such as Wi-Fi and Ethernet.

Add network permissions

Multipath requires permission to access and manage the device network state. Add the following permissions to /app/src/main/AndroidManifest.xml:

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE"/>

Multipath APIs

Video SDK supports enabling and configuring Multipath through the following ChannelMediaOptions fields:

public class ChannelMediaOptions {
  // ...
  public Boolean enableMultipath;
  public Integer uplinkMultipathMode;
  public Integer downlinkMultipathMode;
  public Integer preferMultipathType;
}

Use enableMultipath to enable multipath transmission. Once enabled, the SDK supports two transmission modes:

• Dynamic mode (default): Dynamically selects the optimal transmission path based on network conditions. This mode is suitable for traffic-sensitive scenarios with high user experience requirements, such as conferences and education. In this mode, you can use preferMultipathType to specify a preferred network path, such as Wi-Fi or mobile network.

• Full redundancy mode: Sends data simultaneously across all available network paths. This mode is suitable for scenarios where traffic use is less sensitive but a highly reliable user experience is required, such as outdoor production, broadcasting, and parallel operation. This mode incurs additional fees. Contact support@agora.io to enable it.

You can configure the transmission mode separately for uplink (uplinkMultipathMode) and downlink (downlinkMultipathMode).

When Multipath is enabled, the SDK reports transmission statistics for each path in real time through the onMultipathStats callback. These statistics include traffic consumption for each network type and real-time performance metrics for each path, making it easier to monitor and optimize network performance.

public static class MultipathStats {
  public int lanTxBytes;
  public int lanRxBytes;
  public int wifiTxBytes;
  public int wifiRxBytes;
  public int mobileTxBytes;
  public int mobileRxBytes;
  public int activePathNum;
  public PathStats[] pathStats;
}

Sample code

private String multipathModeStr = "";
private int activePathNum = 0;

mediaOptions.enableMultipath = true;

multipathModeStr = spinner_multipath_mode.getSelectedItem().toString();
Constants.MultipathMode multipathMode = Constants.MultipathMode.valueOf(multipathModeStr);

mediaOptions.uplinkMultipathMode = Constants.MultipathMode.getValue(Constants.MultipathMode.DYNAMIC);
mediaOptions.downlinkMultipathMode = Constants.MultipathMode.getValue(Constants.MultipathMode.DYNAMIC);
mediaOptions.preferMultipathType = Constants.MultipathType.MULTIPATH_TYPE_WIFI.getValue();

@Override
public void onMultipathStats(MultipathStats stats) {
  super.onMultipathStats(stats);
  activePathNum = stats.activePathNum;
}

Multipath APIs

Video SDK supports enabling and configuring Multipath through the following AgoraRtcChannelMediaOptions fields:

__attribute__((visibility("default"))) @interface AgoraRtcChannelMediaOptions : NSObject
// ...
@property(assign, nonatomic) BOOL enableMultipath;
@property(assign, nonatomic) AgoraMultipathMode uplinkMultipathMode;
@property(assign, nonatomic) AgoraMultipathMode downlinkMultipathMode;
@property(assign, nonatomic) AgoraMultipathType preferMultipathType;
@end

Use enableMultipath to enable multipath transmission. Once enabled, the SDK supports two transmission modes:

• Dynamic mode (default): Dynamically selects the optimal transmission path based on network conditions. This mode is suitable for traffic-sensitive scenarios with high user experience requirements, such as conferences and education. In this mode, you can use preferMultipathType to specify a preferred network path, such as Wi-Fi or mobile network.

• Full redundancy mode: Sends data simultaneously across all available network paths. This mode is suitable for scenarios where traffic use is less sensitive but a highly reliable user experience is required, such as outdoor production, broadcasting, and parallel operation. This mode incurs additional fees. Contact support@agora.io to enable it.

You can configure the transmission mode separately for uplink (uplinkMultipathMode) and downlink (downlinkMultipathMode).

When Multipath is enabled, the SDK reports transmission statistics for each path in real time through the multiPathStats callback. These statistics include traffic consumption for each network type and real-time performance metrics for each path, making it easier to monitor and optimize network performance.

__attribute__((visibility("default"))) @interface AgoraMultipathStats : NSObject
@property (assign, nonatomic) NSUInteger lanRxBytes;
@property (assign, nonatomic) NSUInteger lanTxBytes;
@property (assign, nonatomic) NSUInteger wifiRxBytes;
@property (assign, nonatomic) NSUInteger wifiTxBytes;
@property (assign, nonatomic) NSUInteger mobileRxBytes;
@property (assign, nonatomic) NSUInteger mobileTxBytes;
@property (assign, nonatomic) NSUInteger activePathNum;
@property (copy, nonatomic) NSArray<AgoraPathStats *> *_Nullable pathStats NS_SWIFT_NAME(pathStats);
@end

Sample code

@IBOutlet weak var selectModePicker: Picker!
func initSelectModePicker() {
  selectModePicker.label.stringValue = "Mode".localized
  selectModePicker.picker.addItems(withTitles: ["dynamic", "duplicate"])
  selectModePicker.picker.selectItem(at: 0)
}

channelMediaOption.enableMultipath = (multipathSwitch.state == .on)
channelMediaOption.uplinkMultipathMode = (selectModePicker.picker.indexOfSelectedItem == 0) ? .dynamic : .duplicate
channelMediaOption.downlinkMultipathMode = (selectModePicker.picker.indexOfSelectedItem == 0) ? .dynamic : .duplicate

func rtcEngine(_ engine: AgoraRtcEngineKit, multiPathStats stats: AgoraMultipathStats) {
  videos[0].statsInfo?.updateMultipathStats(stats)
}

Multipath APIs

Video SDK supports enabling and configuring Multipath through the following AgoraRtcChannelMediaOptions fields:

__attribute__((visibility("default"))) @interface AgoraRtcChannelMediaOptions : NSObject
// ...
@property(assign, nonatomic) BOOL enableMultipath;
@property(assign, nonatomic) AgoraMultipathMode uplinkMultipathMode;
@property(assign, nonatomic) AgoraMultipathMode downlinkMultipathMode;
@property(assign, nonatomic) AgoraMultipathType preferMultipathType;
@end

Use enableMultipath to enable multipath transmission. Once enabled, the SDK supports two transmission modes:

• Dynamic mode (default): Dynamically selects the optimal transmission path based on network conditions. This mode is suitable for traffic-sensitive scenarios with high user experience requirements, such as conferences and education. In this mode, you can use preferMultipathType to specify a preferred network path, such as Wi-Fi or mobile network.

• Full redundancy mode: Sends data simultaneously across all available network paths. This mode is suitable for scenarios where traffic use is less sensitive but a highly reliable user experience is required, such as outdoor production, broadcasting, and parallel operation. This mode incurs additional fees. Contact support@agora.io to enable it.

You can configure the transmission mode separately for uplink (uplinkMultipathMode) and downlink (downlinkMultipathMode).

When Multipath is enabled, the SDK reports transmission statistics for each path in real time through the multiPathStats callback. These statistics include traffic consumption for each network type and real-time performance metrics for each path, making it easier to monitor and optimize network performance.

__attribute__((visibility("default"))) @interface AgoraMultipathStats : NSObject
@property (assign, nonatomic) NSUInteger lanRxBytes;
@property (assign, nonatomic) NSUInteger lanTxBytes;
@property (assign, nonatomic) NSUInteger wifiRxBytes;
@property (assign, nonatomic) NSUInteger wifiTxBytes;
@property (assign, nonatomic) NSUInteger mobileRxBytes;
@property (assign, nonatomic) NSUInteger mobileTxBytes;
@property (assign, nonatomic) NSUInteger activePathNum;
@property (copy, nonatomic) NSArray<AgoraPathStats *> *_Nullable pathStats NS_SWIFT_NAME(pathStats);
@end

Sample code

@IBOutlet weak var selectModePicker: Picker!
func initSelectModePicker() {
  selectModePicker.label.stringValue = "Mode".localized
  selectModePicker.picker.addItems(withTitles: ["dynamic", "duplicate"])
  selectModePicker.picker.selectItem(at: 0)
}

channelMediaOption.enableMultipath = (multipathSwitch.state == .on)
channelMediaOption.uplinkMultipathMode = (selectModePicker.picker.indexOfSelectedItem == 0) ? .dynamic : .duplicate
channelMediaOption.downlinkMultipathMode = (selectModePicker.picker.indexOfSelectedItem == 0) ? .dynamic : .duplicate

Multipath APIs

Video SDK supports enabling and configuring Multipath through the following ChannelMediaOptions fields:

struct ChannelMediaOptions {
  // ...
  Optional<bool> enableMultipath;
  Optional<MultipathMode> uplinkMultipathMode;
  Optional<MultipathMode> downlinkMultipathMode;
  Optional<MultipathType> preferMultipathType;
};

Use enableMultipath to enable multipath transmission. Once enabled, the SDK supports two transmission modes:

• Dynamic mode (default): Dynamically selects the optimal transmission path based on network conditions. This mode is suitable for traffic-sensitive scenarios with high user experience requirements, such as conferences and education. In this mode, you can use preferMultipathType to specify a preferred network path, such as Wi-Fi or mobile network.

• Full redundancy mode: Sends data simultaneously across all available network paths. This mode is suitable for scenarios where traffic use is less sensitive but a highly reliable user experience is required, such as outdoor production, broadcasting, and parallel operation. This mode incurs additional fees. Contact support@agora.io to enable it.

You can configure the transmission mode separately for uplink (uplinkMultipathMode) and downlink (downlinkMultipathMode).

When Multipath is enabled, the SDK reports transmission statistics for each path in real time through the onMultipathStats callback. These statistics include traffic consumption for each network type and real-time performance metrics for each path, making it easier to monitor and optimize network performance.

struct MultipathStats {
  uint32_t lanTxBytes;
  uint32_t lanRxBytes;
  uint32_t wifiTxBytes;
  uint32_t wifiRxBytes;
  uint32_t mobileTxBytes;
  uint32_t mobileRxBytes;
  int activePathNum;
  const PathStats* pathStats;
};

Sample code

// Initialize UI elements related to multipath transmission
m_cmbMultipathMode.InsertString(0, _T("Duplicate"));
m_cmbMultipathMode.InsertString(1, _T("Dynamic"));
m_cmbMultipathMode.SetCurSel(0);

// Initialize multipath transmission controls
m_staEnableMultipath.SetWindowText(_T("Enable Multipath:"));
m_chkEnableMultipath.SetCheck(BST_UNCHECKED);

ChannelMediaOptions options;
options.enableMultipath = (m_chkEnableMultipath.GetCheck() == BST_CHECKED);

int modeIndex = m_cmbMultipathMode.GetCurSel();
MultipathMode mode = (modeIndex == 0) ? Duplicate : Dynamic;

options.uplinkMultipathMode = mode;
options.downlinkMultipathMode = mode;
options.preferMultipathType = WIFI;

void CMultipathRtcEngineEventHandler::onMultipathStats(const MultipathStats& stats)
{
  if (m_hMsgHanlder)
  {
    MultipathStats* statsPtr = new MultipathStats(stats);
    ::PostMessage(m_hMsgHanlder, WM_MSGID(EID_MULTIPATH_STATS), (WPARAM)statsPtr, 0);
  }
}

API reference

• ChannelMediaOptions
• MultipathStats
• onMultipathStats

API reference

• AgoraRtcChannelMediaOptions
• rtcEngine(_:multiPathStats:)
• AgoraMultipathStats

API reference

• AgoraRtcChannelMediaOptions
• rtcEngine(_:multiPathStats:)
• AgoraMultipathStats

API reference

• ChannelMediaOptions
• onMultipathStats