# 数据流 Datastream (/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## createDataStream [1/2] [#createdatastream-12] 创建数据流。 ```cpp virtual int createDataStream(int* streamId, bool reliable, bool ordered) = 0; ``` 你可以调用该方法创建数据流并提高数据传输的可靠性和有序性。 ### 调用时机 [#调用时机] 该方法在加入频道前后均可调用。 ### 调用限制 [#调用限制] 在 [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) 生命周期内,每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁,如需使用需要重新创建数据流。 ### 相关回调 [#相关回调] 将 reliable 设置为 `true` 后,如果接收方 5 秒没有收到发送方所发送的数据,会触发 [onStreamMessageError](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调并获得相应报错信息。 ### 参数 [#参数] 输出参数,创建好的数据流 ID。 是否保证数据可靠性,即接收方是否需要在数据发送后的 5 秒内接收: - `true`: 接收方 5 秒内会收到发送方所发送的数据,否则会收到 onStreamMessageError 回调并获得相应报错信息。 - `false`: 接收方不保证收到,就算数据丢失也不会报错。 :::caution 注意: 请确保将 reliable 和 ordered 同时设为 `true` 或同时设为 `false`。 ::: 是否保证数据有序性,即接收方是否需要收到有序的数据: - `true`: 接收方会按照发送方发送的顺序收到数据包。 - `false`: 接收方不保证按照发送方发送的顺序收到数据包。 ### 返回值 [#返回值] - 0: 创建数据流成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## createDataStreamEx [1/2] [#createdatastreamex-12] 创建数据流。 ```cpp virtual int createDataStreamEx(int* streamId, bool reliable, bool ordered, const RtcConnection& connection) = 0; ``` :::error[弃用:] 该方法已废弃。请改用 [createDataStreamEx [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#api_irtcengineex_createdatastreamex2)。 ::: 你可以调用该方法创建数据流并提高数据传输的可靠性和有序性。 ### 调用时机 [#调用时机-1] 该方法需要在 [joinChannelEx](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengineex_joinchannelex) 后调用。 ### 调用限制 [#调用限制-1] 在 [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) 生命周期内,每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁,如需使用需要重新创建数据流。 ### 相关回调 [#相关回调-1] 将 reliable 设置为 `true` 后,如果接收方 5 秒没有收到发送方所发送的数据,会触发 [onStreamMessageError](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调并获得相应报错信息。 ### 参数 [#参数-1] 输出参数,创建好的数据流 ID。 是否保证数据可靠性,即接收方是否需要在数据发送后的 5 秒内接收: - `true`: 接收方 5 秒内会收到发送方所发送的数据,否则会收到 onStreamMessageError 回调并获得相应报错信息。 - `false`: 接收方不保证收到,就算数据丢失也不会报错。 :::caution 注意: 请确保将 reliable 和 ordered 同时设为 `true` 或同时设为 `false`。 ::: 是否保证数据有序性,即接收方是否需要收到有序的数据: - `true`: 接收方会按照发送方发送的顺序收到数据包。 - `false`: 接收方不保证按照发送方发送的顺序收到数据包。 Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unreal-cpp/class-rtcconnection)。 ### 返回值 [#返回值-1] - 0: 创建数据流成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-1] - [IRtcEngineEx](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineex) ## createDataStream [2/2] [#createdatastream-22] 创建数据流。 ```cpp virtual int createDataStream(int* streamId, DataStreamConfig& config) = 0; ``` 相比 [createDataStream [1/2]](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#api_irtcengine_createdatastream),本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。 ### 调用时机 [#调用时机-2] 该方法在加入频道前后均可调用。 ### 调用限制 [#调用限制-2] 在 [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) 生命周期内,每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁,如需使用需要重新创建数据流。 ### 参数 [#参数-2] 输出参数,创建好的数据流 ID。 数据流设置。详见 [DataStreamConfig](/zh-CN/api-reference/rtc/unreal-cpp/class-datastreamconfig)。 ### 返回值 [#返回值-2] - 0: 创建数据流成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-2] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## createDataStreamEx [2/2] [#createdatastreamex-22] 创建数据流。 ```cpp virtual int createDataStreamEx(int* streamId, DataStreamConfig& config, const RtcConnection& connection) = 0; ``` 相比 [createDataStreamEx [1/2]](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#api_irtcengineex_createdatastreamex),本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。 ### 调用时机 [#调用时机-3] 该方法需要在 [joinChannelEx](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengineex_joinchannelex) 后调用。 ### 调用限制 [#调用限制-3] 在 [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) 生命周期内,每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁,如需使用需要重新创建数据流。 ### 参数 [#参数-3] 输出参数,创建好的数据流 ID。 数据流设置。详见 [DataStreamConfig](/zh-CN/api-reference/rtc/unreal-cpp/class-datastreamconfig)。 Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unreal-cpp/class-rtcconnection)。 ### 返回值 [#返回值-3] - 0: 创建数据流成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-3] - [IRtcEngineEx](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineex) ## sendStreamMessage [#sendstreammessage] 发送数据流。 ```cpp virtual int sendStreamMessage(int streamId, const char* data, size_t length) = 0; ``` ### 详情 [#详情] 调用 [createDataStream [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#api_irtcengine_createdatastream2) 后,你可以调用该方法向频道内所有用户发送数据流消息。 SDK 对该方法的实现进行了如下限制: - 频道内每个客户端最多可以同时拥有 5 个数据通道,所有数据通道共用的总发包码率限制为 30 KB/s。 - 每个数据通道每秒最多能发送 60 个包,每个包最大为 1 KB。 成功调用该方法后,远端会触发 [onStreamMessage](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#callback_irtcengineeventhandler_onstreammessage) 回调,远端用户可以在该回调中获取接收到的流消息;若调用失败,远端会触发 [onStreamMessageError](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调。 :::caution 注意: - 该方法需要在加入频道后、且调用 [createDataStream [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#api_irtcengine_createdatastream2) 创建数据通道之后调用。 - 该方法仅适用于主播用户。 ::: ### 参数 [#参数-4] 数据流 ID。可以通过 createDataStream [2/2] 获取。 待发送的数据。 数据长度。 ### 返回值 [#返回值-4] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-4] - [IRtcEngine](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengine) ## sendStreamMessageEx [#sendstreammessageex] 发送数据流。 ```cpp virtual int sendStreamMessageEx(int streamId, const char* data, size_t length, const RtcConnection& connection) = 0; ``` ### 详情 [#详情-1] 调用 [createDataStreamEx [2/2]](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#api_irtcengineex_createdatastreamex2) 后,你可以调用本方法向频道内所有用户发送数据流消息。 SDK 对该方法的实现进行了如下限制: - 频道内每个客户端最多可以同时拥有 5 个数据通道,所有数据通道共用的总发包码率限制为 30 KB/s。 - 每个数据通道每秒最多能发送 60 个包,每个包最大为 1 KB。 成功调用该方法后,远端会触发 [onStreamMessage](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#callback_irtcengineeventhandler_onstreammessage) 回调,远端用户可以在该回调中获取接收到的流消息;若调用失败,远端会触发 [onStreamMessageError](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调。 :::caution 注意: - 该方法需要在 [joinChannelEx](/zh-CN/api-reference/rtc/unreal-cpp/channel#api_irtcengineex_joinchannelex) 后调用。 - 请确保在调用该方法前,已调用 createDataStreamEx [2/2] 创建了数据通道。 ::: ### 参数 [#参数-5] 数据流 ID。可以通过 createDataStreamEx [2/2] 获取。 待发送的数据。 数据长度。 Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unreal-cpp/class-rtcconnection)。 ### 返回值 [#返回值-5] - 0: 方法调用成功。 - < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-5] - [IRtcEngineEx](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineex) ## onStreamMessage [#onstreammessage] 接收到对方数据流消息的回调。 ```cpp virtual void onStreamMessage(uid_t userId, int streamId, const char* data, size_t length, uint64_t sentTs) { (void)userId; (void)streamId; (void)data; (void)length; (void)sentTs; } ``` ### 详情 [#详情-2] 该回调表示本地用户收到了远端用户调用 [sendStreamMessage](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#api_irtcengine_sendstreammessage) 方法发送的流消息。 ### 参数 [#参数-6] 发送消息的用户 ID。 接收到的消息的 Stream ID。 接收到的数据。 数据长度,单位为字节。 数据流发出的时间。 ### 所属接口类 [#所属接口类-6] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler) ## onStreamMessageError [#onstreammessageerror] 接收对方数据流消息发生错误的回调。 ```cpp virtual void onStreamMessageError(uid_t userId, int streamId, int code, int missed, int cached) { (void)userId; (void)streamId; (void)code; (void)missed; (void)cached; } ``` ### 详情 [#详情-3] 该回调表示本地用户未收到远端用户调用 [sendStreamMessage](/zh-CN/api-reference/rtc/unreal-cpp/metadata/datastream#api_irtcengine_sendstreammessage) 方法发送的流消息。 ### 参数 [#参数-7] 发送消息的用户 ID。 接收到的消息的 Stream ID。 错误码。详见 [错误码](/zh-CN/api-reference/rtc/error-code)。 丢失的消息数量。 数据流中断时,后面缓存的消息数量。 ### 所属接口类 [#所属接口类-7] - [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unreal-cpp/rtc-interface-class#class_irtcengineeventhandler)