# 数据流 Datastream (/zh-CN/api-reference/rtc/macos/metadata/datastream) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## createDataStream\:reliable\:ordered: [#createdatastreamreliableordered] 创建数据流。 ```objc - (int)createDataStream:(NSInteger * _Nonnull)streamId reliable:(BOOL)reliable ordered:(BOOL)ordered NS_SWIFT_NAME(createDataStream(_:reliable:ordered:)); ``` 你可以调用该方法创建一个数据流,以提升数据传输的可靠性和顺序性。你可以在加入频道前或后调用该方法。 :::note 注: 每个用户在 [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine) 的生命周期内最多可创建五个数据流。离开频道时数据流会被销毁,如需继续使用需重新创建。如果你需要更全面的低延时、高并发、可扩展的实时消息和状态同步方案,建议使用实时消息。 ::: ### 调用时机 [#调用时机] 你可以在加入频道前或后调用该方法。 ### 参数 [#参数] 输出参数,创建的数据流 ID。 设置接收端是否保证在五秒内收到数据流: - YES:接收端会在五秒内收到发送方发送的数据。如果接收端在五秒内未收到数据,SDK 会触发 [rtcEngine\:didOccurStreamMessageErrorFromUid\:streamId\:error\:missed\:cached:](/zh-CN/api-reference/rtc/macos/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调并返回错误码。 - NO:不保证接收端在五秒内收到数据流,延迟或丢失数据不会返回错误信息。 请确保 `reliable` 和 `ordered` 同时设置为 YES 或同时设置为 NO。 设置接收端是否按发送顺序接收数据流: - YES:接收端按发送顺序接收数据。 - NO:接收端不按发送顺序接收数据。 ### 返回值 [#返回值] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类] - [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine) ## createDataStream\:config: [#createdatastreamconfig] 创建一个数据流。 ```objc - (int)createDataStream:(NSInteger * _Nonnull)streamId config:(AgoraDataStreamConfig * _Nonnull)config NS_SWIFT_NAME(createDataStream(_:config:)); ``` 与 [createDataStream\:reliable\:ordered:](/zh-CN/api-reference/rtc/macos/metadata/datastream#api_irtcengine_createdatastream1) 方法相比,该方法不保证数据传输的可靠性。如果数据包在发送后五秒内未被接收,SDK 会直接丢弃该数据包。你可以在加入频道前或加入频道后调用该方法。 :::note 注: 每个用户在 [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine) 的生命周期内最多可以创建五个数据流。离开频道时数据流会被销毁,如需使用需重新创建。如果你需要一个更全面的低延迟、高并发、可扩展的实时消息和状态同步解决方案,建议使用实时消息。 ::: ### 调用时机 [#调用时机-1] 你可以在加入频道前或加入频道后调用该方法。 ### 参数 [#参数-1] 输出参数,创建的数据流 ID。 数据流的配置,详见 [AgoraDataStreamConfig](/zh-CN/api-reference/rtc/macos/class-datastreamconfig)。 ### 返回值 [#返回值-1] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-1] - [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine) ## createDataStreamEx\:reliable\:ordered\:connection: [#createdatastreamexreliableorderedconnection] 创建一个数据流。 ```objc - (int)createDataStreamEx:(NSInteger * _Nonnull)streamId reliable:(BOOL)reliable ordered:(BOOL)ordered connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(createDataStreamEx(_:reliable:ordered:connection:)); ``` :::error[废弃] 该方法已废弃,请改用 [createDataStreamEx\:config\:connection:](/zh-CN/api-reference/rtc/macos/metadata/datastream#api_irtcengineex_createdatastreamex2)。 ::: 你可以调用此方法创建一个数据流,以提升数据传输的可靠性和顺序性。 :::note 注: 每个用户在 [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine) 的生命周期中最多可创建五个数据流。离开频道时数据流会被销毁,如需使用需重新创建。 ::: ### 适用场景 [#适用场景] 该方法适用于多频道场景。 ### 调用时机 [#调用时机-2] 请在调用 `joinChannelExByToken` 之后调用此方法。 ### 参数 [#参数-2] 输出参数,创建的数据流 ID。 设置是否保证接收端在五秒内收到数据流: - YES:接收端会在五秒内收到发送方发送的数据。如果五秒内未收到,SDK 会触发 [rtcEngine\:didOccurStreamMessageErrorFromUid\:streamId\:error\:missed\:cached:](/zh-CN/api-reference/rtc/macos/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调并返回错误码。 - NO:不保证接收端在五秒内收到数据流,延迟或丢失不会返回错误信息。 注意:请确保 `reliable` 和 `ordered` 同时设置为 YES 或同时设置为 NO。 设置接收端是否按发送顺序接收数据流: - YES:接收端按发送顺序接收数据。 - NO:接收端不按发送顺序接收数据。 连接信息。详见 [AgoraRtcConnection](/zh-CN/api-reference/rtc/macos/class-rtcconnection)。 ### 返回值 [#返回值-2] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-2] - [AgoraRtcEngineKit(Ex)](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengineex) ## createDataStreamEx\:config\:connection: [#createdatastreamexconfigconnection] 创建一个数据流。 ```objc - (int)createDataStreamEx:(NSInteger * _Nonnull)streamId config:(AgoraDataStreamConfig * _Nonnull)config connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(createDataStreamEx(_:config:connection:)); ``` 该方法不保证数据传输的可靠性。如果数据包在发送后五秒内未被接收,SDK 会直接丢弃该数据。 :::note 注: 每个用户在 [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine) 的生命周期内最多可以创建五个数据流。离开频道时数据流会被销毁,如需使用需重新创建。如果你需要一个更全面的低延迟、高并发、可扩展的实时消息和状态同步解决方案,建议使用实时消息。 ::: ### 适用场景 [#适用场景-1] 该方法适用于多频道场景。 ### 调用时机 [#调用时机-3] 请在调用 `joinChannelExByToken` 方法后调用该方法。 ### 参数 [#参数-3] 输出参数,创建的数据流 ID。 数据流的配置。详见 [AgoraDataStreamConfig](/zh-CN/api-reference/rtc/macos/class-datastreamconfig)。 连接信息。详见 [AgoraRtcConnection](/zh-CN/api-reference/rtc/macos/class-rtcconnection)。 ### 返回值 [#返回值-3] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-3] - [AgoraRtcEngineKit(Ex)](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengineex) ## sendStreamMessage\:data: [#sendstreammessagedata] 发送数据流消息。 ```objc - (int)sendStreamMessage:(NSInteger)streamId data:(NSData * _Nonnull)data NS_SWIFT_NAME(sendStreamMessage(_:data:)); ``` 调用 [createDataStream\:config:](/zh-CN/api-reference/rtc/macos/metadata/datastream#api_irtcengine_createdatastream2) 后,你可以使用此方法向频道内的所有用户发送数据流消息。SDK 对此方法有以下限制: - 每个客户端在频道中最多可同时拥有 5 个数据通道,所有数据通道共享的总包比特率上限为 30 KB/s。 - 每个数据通道每秒最多可发送 60 个数据包,每个数据包最大为 1 KB。 :::note 注: 如果你需要一个更全面的解决方案来实现低延迟、高并发和可扩展的实时消息传递和状态同步,建议使用实时消息。 - 必须在调用 [createDataStream\:config:](/zh-CN/api-reference/rtc/macos/metadata/datastream#api_irtcengine_createdatastream2) 并加入频道后调用此方法。 - 此方法仅适用于主播。 ::: ### 参数 [#参数-4] 数据流 ID。你可以通过调用 [createDataStream\:config:](/zh-CN/api-reference/rtc/macos/metadata/datastream#api_irtcengine_createdatastream2) 获取该 ID。 要发送的消息。 ### 返回值 [#返回值-4] - 0:方法调用成功。 - < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。 ### 所属接口类 [#所属接口类-4] - [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine) ## rtcEngine\:receiveStreamMessageFromUid\:streamId\:data: [#rtcenginereceivestreammessagefromuidstreamiddata] 当本地用户收到远端用户发送的数据流时触发。 ```objc - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine receiveStreamMessageFromUid:(NSUInteger)uid streamId:(NSInteger)streamId data:(NSData * _Nonnull)data NS_SWIFT_NAME(rtcEngine(_:receiveStreamMessageFromUid:streamId:data:)); ``` 当你收到远端用户通过调用 [sendStreamMessage\:data:](/zh-CN/api-reference/rtc/macos/metadata/datastream#api_irtcengine_sendstreammessage) 发送的数据流消息时,SDK 会触发该回调。 :::note 注: 如果你需要一个更全面的低延迟、高并发、可扩展的实时消息和状态同步解决方案,建议使用实时消息。 ::: ### 触发时机 [#触发时机] 该回调在你收到远端用户发送的数据流时被触发。 ### 参数 [#参数-5] [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine) 对象,详见 [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)。 发送该消息的远端用户 ID。 接收到的消息所属的数据流 ID。 接收到的数据内容, ### 所属接口类 [#所属接口类-5] - [AgoraRtcEngineDelegate](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengineeventhandler) ## rtcEngine\:didOccurStreamMessageErrorFromUid\:streamId\:error\:missed\:cached: [#rtcenginedidoccurstreammessageerrorfromuidstreamiderrormissedcached] 当本地用户未收到远端用户发送的数据流时触发的回调。 ```objc - (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didOccurStreamMessageErrorFromUid:(NSUInteger)uid streamId:(NSInteger)streamId error:(NSInteger)error missed:(NSInteger)missed cached:(NSInteger)cached NS_SWIFT_NAME(rtcEngine(_:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached:)); ``` 当本地用户未能接收到远端用户通过调用 [sendStreamMessage\:data:](/zh-CN/api-reference/rtc/macos/metadata/datastream#api_irtcengine_sendstreammessage) 方法发送的数据流消息时,SDK 会触发该回调。 :::note 注: 如果你需要一个更全面的低延迟、高并发、可扩展的实时消息和状态同步解决方案,建议使用实时消息。 ::: ### 触发时机 [#触发时机-1] 该回调在本地用户未收到远端用户发送的数据流时被触发。 ### 参数 [#参数-6] 引擎对象,详见 [AgoraRtcEngineKit](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengine)。 远端用户 ID。 接收消息所属的数据流 ID。 错误码。 丢失的消息数量。 数据流中断时缓存的传入消息数量。 ### 所属接口类 [#所属接口类-6] - [AgoraRtcEngineDelegate](/zh-CN/api-reference/rtc/macos/rtc-interface-class#class_irtcengineeventhandler)