# 数据流 Datastream (/zh-CN/api-reference/rtc/flutter/metadata/datastream)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## createDataStream [#createdatastream]
创建数据流。
```dart
Future createDataStream(DataStreamConfig config);
```
:::note
注: 如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案,推荐使用实时消息。
在 [RtcEngine](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengine) 生命周期内,每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁,如需使用需要重新创建数据流。
:::
### 调用时机 [#调用时机]
该方法在加入频道前后均可调用。
### 参数 [#参数]
数据流设置。详见 [DataStreamConfig](/zh-CN/api-reference/rtc/flutter/class-datastreamconfig)。
### 返回值 [#返回值]
- 创建的数据流的 ID:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类]
- [RtcEngine](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengine)
## createDataStreamEx [#createdatastreamex]
创建数据流。
```dart
Future createDataStreamEx(
{required DataStreamConfig config, required RtcConnection connection});
```
:::note
注: 如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案,推荐使用实时消息。
在 [RtcEngine](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengine) 生命周期内,每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁,如需使用需要重新创建数据流。
:::
### 调用时机 [#调用时机-1]
该方法需要在 [joinChannelEx](/zh-CN/api-reference/rtc/flutter/channel#api_irtcengineex_joinchannelex) 后调用。
### 参数 [#参数-1]
数据流设置。详见 [DataStreamConfig](/zh-CN/api-reference/rtc/flutter/class-datastreamconfig)。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/flutter/class-rtcconnection)。
### 返回值 [#返回值-1]
- 创建的数据流的 ID:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-1]
- [RtcEngineEx](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengineex)
## sendStreamMessage [#sendstreammessage]
发送数据流。
```dart
Future sendStreamMessage(
{required int streamId, required Uint8List data, required int length});
```
调用 [createDataStream](/zh-CN/api-reference/rtc/flutter/metadata/datastream#api_irtcengine_createdatastream2) 后,你可以调用该方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制:
- 频道内每个客户端最多可以同时拥有 5 个数据通道,所有数据通道共用的总发包码率限制为 30 KB/s。
- 每个数据通道每秒最多能发送 60 个包,每个包最大为 1 KB。
成功调用该方法后,远端会触发 [onStreamMessage](/zh-CN/api-reference/rtc/flutter/metadata/datastream#callback_irtcengineeventhandler_onstreammessage) 回调,远端用户可以在该回调中获取接收到的流消息;若调用失败,远端会触发 [onStreamMessageError](/zh-CN/api-reference/rtc/flutter/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调。
:::note
注: 如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案,推荐使用实时消息。
- 该方法需要在加入频道后、且调用 [createDataStream](/zh-CN/api-reference/rtc/flutter/metadata/datastream#api_irtcengine_createdatastream2) 创建数据通道之后调用。
- 该方法仅适用于主播用户。
:::
### 参数 [#参数-2]
数据流 ID。可以通过 [createDataStream](/zh-CN/api-reference/rtc/flutter/metadata/datastream#api_irtcengine_createdatastream2) 获取。
待发送的数据。
数据长度。
### 返回值 [#返回值-2]
方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-2]
- [RtcEngine](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengine)
## sendStreamMessageEx [#sendstreammessageex]
发送数据流。
```dart
Future sendStreamMessageEx(
{required int streamId,
required Uint8List data,
required int length,
required RtcConnection connection});
```
调用 [createDataStreamEx](/zh-CN/api-reference/rtc/flutter/metadata/datastream#api_irtcengineex_createdatastreamex2) 后,你可以调用本方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制:
- 频道内每个客户端最多可以同时拥有 5 个数据通道,所有数据通道共用的总发包码率限制为 30 KB/s。
- 每个数据通道每秒最多能发送 60 个包,每个包最大为 1 KB。
成功调用该方法后,远端会触发 [onStreamMessage](/zh-CN/api-reference/rtc/flutter/metadata/datastream#callback_irtcengineeventhandler_onstreammessage) 回调,远端用户可以在该回调中获取接收到的流消息;若调用失败,远端会触发 [onStreamMessageError](/zh-CN/api-reference/rtc/flutter/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调。
:::note
注:
- 如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案,推荐使用实时消息。
- 该方法需要在 [joinChannelEx](/zh-CN/api-reference/rtc/flutter/channel#api_irtcengineex_joinchannelex) 后调用。
- 请确保在调用该方法前,已调用 [createDataStreamEx](/zh-CN/api-reference/rtc/flutter/metadata/datastream#api_irtcengineex_createdatastreamex2) 创建了数据通道。
:::
### 参数 [#参数-3]
数据流 ID。可以通过 [createDataStreamEx](/zh-CN/api-reference/rtc/flutter/metadata/datastream#api_irtcengineex_createdatastreamex2) 获取。
待发送的数据。
数据长度。
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/flutter/class-rtcconnection)。
### 返回值 [#返回值-3]
方法成功调用时,无返回值;方法调用失败时,会抛出 [AgoraRtcException](/zh-CN/api-reference/rtc/flutter/class-agorartcexception) 异常,你需要捕获异常并进行处理。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-3]
- [RtcEngineEx](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengineex)
## onStreamMessage [#onstreammessage]
接收到对方数据流消息的回调。
```dart
final void Function(RtcConnection connection, int remoteUid, int streamId,
Uint8List data, int length, int sentTs)? onStreamMessage;
```
该回调表示本地用户收到了远端用户调用 [sendStreamMessage](/zh-CN/api-reference/rtc/flutter/metadata/datastream#api_irtcengine_sendstreammessage) 方法发送的流消息。
:::note
注: 如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案,推荐使用实时消息。
:::
### 参数 [#参数-4]
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/flutter/class-rtcconnection)。
发送消息的用户 ID。
接收到的消息的 Stream ID。
接收到的数据。
数据长度,单位为字节。
数据流发出的时间。
### 所属接口类 [#所属接口类-4]
- [RtcEngineEventHandler](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengineeventhandler)
## onStreamMessageError [#onstreammessageerror]
接收对方数据流消息发生错误的回调。
```dart
final void Function(RtcConnection connection, int remoteUid, int streamId,
ErrorCodeType code, int missed, int cached)? onStreamMessageError;
```
该回调表示本地用户未收到远端用户调用 [sendStreamMessage](/zh-CN/api-reference/rtc/flutter/metadata/datastream#api_irtcengine_sendstreammessage) 方法发送的流消息。
:::note
注: 如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案,推荐使用实时消息。
:::
### 参数 [#参数-5]
Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/flutter/class-rtcconnection)。
发送消息的用户 ID。
接收到的消息的 Stream ID。
错误码。详见 [ErrorCodeType](/zh-CN/api-reference/rtc/flutter/enum-errorcodetype)。
丢失的消息数量。
数据流中断时,后面缓存的消息数量。
### 所属接口类 [#所属接口类-5]
- [RtcEngineEventHandler](/zh-CN/api-reference/rtc/flutter/rtc-interface-class#class_irtcengineeventhandler)