# 数据流 Datastream (/zh-CN/api-reference/rtc/unreal-blueprint/metadata/datastream)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## CreateDataStream [#createdatastream]
创建数据流。
```cpp
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int CreateDataStream(int& streamId, const FDataStreamConfig& config);
```
### 调用时机 [#调用时机]
该方法在加入频道前后均可调用。
### 调用限制 [#调用限制]
在 [IRtcEngine](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_irtcengine) 生命周期内,每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁,如需使用需要重新创建数据流。
### 参数 [#参数]
输出参数,创建好的数据流 ID。
数据流设置。详见 [FDataStreamConfig](/zh-CN/api-reference/rtc/unreal-blueprint/class-datastreamconfig)。
### 返回值 [#返回值]
- 0: 创建数据流成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_irtcengine)
## CreateDataStreamEx [#createdatastreamex]
创建数据流。
```cpp
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int CreateDataStreamEx(int& streamId, const FDataStreamConfig& config, const FRtcConnection& connection);
```
### 调用时机 [#调用时机-1]
该方法需要在 [JoinChannelEx](/zh-CN/api-reference/rtc/unreal-blueprint/channel#api_irtcengineex_joinchannelex) 后调用。
### 调用限制 [#调用限制-1]
在 [IRtcEngine](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_irtcengine) 生命周期内,每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁,如需使用需要重新创建数据流。
### 参数 [#参数-1]
输出参数,创建好的数据流 ID。
数据流设置。详见 [FDataStreamConfig](/zh-CN/api-reference/rtc/unreal-blueprint/class-datastreamconfig)。
Connection 信息。详见 [FUABT_RtcConnection](/zh-CN/api-reference/rtc/unreal-blueprint/class-rtcconnection)。
### 返回值 [#返回值-1]
- 0: 创建数据流成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-1]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_irtcengineex)
## SendStreamMessage [#sendstreammessage]
发送数据流。
```cpp
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SendStreamMessage(int streamId, const FString& data);
```
### 详情 [#详情]
调用 [CreateDataStream](/zh-CN/api-reference/rtc/unreal-blueprint/metadata/datastream#api_irtcengine_createdatastream2) 后,你可以调用该方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制:
- 频道内每个客户端最多可以同时拥有 5 个数据通道,所有数据通道共用的总发包码率限制为 30 KB/s。
- 每个数据通道每秒最多能发送 60 个包,每个包最大为 1 KB。
成功调用该方法后,远端会触发 [OnStreamMessage](/zh-CN/api-reference/rtc/unreal-blueprint/metadata/datastream#callback_irtcengineeventhandler_onstreammessage) 回调,远端用户可以在该回调中获取接收到的流消息;若调用失败,远端会触发 [OnStreamMessageError](/zh-CN/api-reference/rtc/unreal-blueprint/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调。
:::caution
注意:
- 该方法需要在加入频道后、且调用 [CreateDataStream](/zh-CN/api-reference/rtc/unreal-blueprint/metadata/datastream#api_irtcengine_createdatastream2) 创建数据通道之后调用。
- 该方法仅适用于主播用户。
:::
### 参数 [#参数-2]
数据流 ID。可以通过 CreateDataStream 获取。
待发送的数据。
数据长度。
### 返回值 [#返回值-2]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-2]
- [IRtcEngine](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_irtcengine)
## SendStreamMessageEx [#sendstreammessageex]
发送数据流。
```cpp
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SendStreamMessageEx(int streamId, const FString& data, const FRtcConnection& connection);
```
### 详情 [#详情-1]
调用 [CreateDataStreamEx](/zh-CN/api-reference/rtc/unreal-blueprint/metadata/datastream#api_irtcengineex_createdatastreamex2) 后,你可以调用本方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制:
- 频道内每个客户端最多可以同时拥有 5 个数据通道,所有数据通道共用的总发包码率限制为 30 KB/s。
- 每个数据通道每秒最多能发送 60 个包,每个包最大为 1 KB。
成功调用该方法后,远端会触发 [OnStreamMessage](/zh-CN/api-reference/rtc/unreal-blueprint/metadata/datastream#callback_irtcengineeventhandler_onstreammessage) 回调,远端用户可以在该回调中获取接收到的流消息;若调用失败,远端会触发 [OnStreamMessageError](/zh-CN/api-reference/rtc/unreal-blueprint/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调。
:::caution
注意:
- 该方法需要在 [JoinChannelEx](/zh-CN/api-reference/rtc/unreal-blueprint/channel#api_irtcengineex_joinchannelex) 后调用。
- 请确保在调用该方法前,已调用 CreateDataStreamEx 创建了数据通道。
:::
### 参数 [#参数-3]
数据流 ID。可以通过 CreateDataStreamEx 获取。
待发送的数据。
数据长度。
Connection 信息。详见 [FUABT_RtcConnection](/zh-CN/api-reference/rtc/unreal-blueprint/class-rtcconnection)。
### 返回值 [#返回值-3]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-3]
- [IRtcEngineEx](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_irtcengineex)
## OnStreamMessage [#onstreammessage]
接收到对方数据流消息的回调。
```cpp
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
void OnStreamMessage(int64 uid, int streamId, const FString& data, int length, int64 sentTs);
```
### 详情 [#详情-2]
该回调表示本地用户收到了远端用户调用 [SendStreamMessage](/zh-CN/api-reference/rtc/unreal-blueprint/metadata/datastream#api_irtcengine_sendstreammessage) 方法发送的流消息。
### 参数 [#参数-4]
发送消息的用户 ID。
接收到的消息的 Stream ID。
接收到的数据。
数据长度,单位为字节。
数据流发出的时间。
### 所属接口类 [#所属接口类-4]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_irtcengineeventhandler)
## OnStreamMessageError [#onstreammessageerror]
接收对方数据流消息发生错误的回调。
```cpp
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
void OnStreamMessageError(int64 uid, int streamId, int code, int missed, int cached);
```
### 详情 [#详情-3]
该回调表示本地用户未收到远端用户调用 [SendStreamMessage](/zh-CN/api-reference/rtc/unreal-blueprint/metadata/datastream#api_irtcengine_sendstreammessage) 方法发送的流消息。
### 参数 [#参数-5]
发送消息的用户 ID。
接收到的消息的 Stream ID。
错误码。详见 [错误码](/zh-CN/api-reference/rtc/error-code)。
丢失的消息数量。
数据流中断时,后面缓存的消息数量。
### 所属接口类 [#所属接口类-5]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-blueprint/rtc-interface-class#class_irtcengineeventhandler)