数据流 Datastream
createDataStream:reliable:ordered:
创建数据流。
- (int)createDataStream:(NSInteger * _Nonnull)streamId
reliable:(BOOL)reliable
ordered:(BOOL)ordered;
你可以调用该方法创建数据流并提高数据传输的可靠性和有序性。
调用时机
该方法在加入频道前后均可调用。
调用限制
在 AgoraRtcEngineKit 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
相关回调
将 reliable 设置为 YES 后，如果接收方 5 秒没有收到发送方所发送的数据，会触发 rtcEngine:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached: 回调并获得相应报错信息。
参数
- streamId
- 输出参数，创建好的数据流 ID。
- reliable
- 是否保证数据可靠性，即接收方是否需要在数据发送后的 5 秒内接收：
YES: 接收方 5 秒内会收到发送方所发送的数据，否则会收到 rtcEngine:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached: 回调并获得相应报错信息。NO: 接收方不保证收到，就算数据丢失也不会报错。
注意请确保将 reliable 和 ordered 同时设为YES或同时设为NO。 - ordered
- 是否保证数据有序性，即接收方是否需要收到有序的数据：
YES: 接收方会按照发送方发送的顺序收到数据包。NO: 接收方不保证按照发送方发送的顺序收到数据包。
返回值
- 0: 创建数据流成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
createDataStream:config:
创建数据流。
- (int)createDataStream:(NSInteger * _Nonnull)streamId
config:(AgoraDataStreamConfig * _Nonnull)config;
相比 createDataStream:reliable:ordered:，本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。
调用时机
该方法在加入频道前后均可调用。
调用限制
在 AgoraRtcEngineKit 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
参数
- streamId
- 输出参数，创建好的数据流 ID。
- config
- 数据流设置。详见 AgoraDataStreamConfig。
返回值
- 0: 创建数据流成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
createDataStreamEx:reliable:ordered:connection:
创建数据流。
- (int)createDataStreamEx:(NSInteger * _Nonnull)streamId
reliable:(BOOL)reliable
ordered:(BOOL)ordered
connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(createDataStreamEx(_:reliable:ordered:connection:));
你可以调用该方法创建数据流并提高数据传输的可靠性和有序性。
调用时机
该方法需要在 joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess: 后调用。
调用限制
在 AgoraRtcEngineKit 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
相关回调
将 reliable 设置为 YES 后，如果接收方 5 秒没有收到发送方所发送的数据，会触发 rtcEngine:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached: 回调并获得相应报错信息。
参数
- streamId
- 输出参数，创建好的数据流 ID。
- reliable
- 是否保证数据可靠性，即接收方是否需要在数据发送后的 5 秒内接收：
YES: 接收方 5 秒内会收到发送方所发送的数据，否则会收到 rtcEngine:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached: 回调并获得相应报错信息。NO: 接收方不保证收到，就算数据丢失也不会报错。
注意请确保将 reliable 和 ordered 同时设为YES或同时设为NO。 - ordered
- 是否保证数据有序性，即接收方是否需要收到有序的数据：
YES: 接收方会按照发送方发送的顺序收到数据包。NO: 接收方不保证按照发送方发送的顺序收到数据包。
- connection
- Connection 信息。详见 AgoraRtcConnection。
返回值
- 0: 创建数据流成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
createDataStreamEx:config:connection:
创建数据流。
- (int)createDataStreamEx:(NSInteger * _Nonnull)streamId
config:(AgoraDataStreamConfig * _Nonnull)config
connection:(AgoraRtcConnection * _Nonnull)connection NS_SWIFT_NAME(createDataStreamEx(_:config:connection:));
相比 createDataStreamEx:reliable:ordered:connection:，本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。
调用时机
该方法需要在 joinChannelExByToken:connection:delegate:mediaOptions:joinSuccess: 后调用。
调用限制
在 AgoraRtcEngineKit 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
参数
- streamId
- 输出参数，创建好的数据流 ID。
- config
- 数据流设置。详见 AgoraDataStreamConfig。
- connection
- Connection 信息。详见 AgoraRtcConnection。
返回值
- 0: 创建数据流成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
sendStreamMessage:data:
发送数据流。
- (int)sendStreamMessage:(NSInteger)streamId
data:(NSData * _Nonnull)data;
详情
调用 createDataStream:config: 后，你可以调用该方法向频道内所有用户发送数据流消息。
- 频道内每个客户端最多可以同时拥有 5 个数据通道，所有数据通道共用的总发包码率限制为 30 KB/s。
- 每个数据通道每秒最多能发送 60 个包，每个包最大为 1 KB。
成功调用该方法后，远端会触发 rtcEngine:receiveStreamMessageFromUid:streamId:data: 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 rtcEngine:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached: 回调。
- 该方法需要在加入频道后、且调用 createDataStream:config: 创建数据通道之后调用。
- 直播场景下，该方法仅适用于主播用户。
参数
- streamId
- 数据流 ID。可以通过 createDataStream:config: 获取。
- data
- 待发送的数据。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
rtcEngine:receiveStreamMessageFromUid:streamId:data:
接收到对方数据流消息的回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
receiveStreamMessageFromUid:(NSUInteger)uid
streamId:(NSInteger)streamId
data:(NSData * _Nonnull)data;
详情
该回调表示本地用户收到了远端用户调用 sendStreamMessage:data: 方法发送的流消息。
参数
- engine
- AgoraRtcEngineKit 对象。
- uid
- 发送消息的用户 ID。
- streamId
- 接收到的消息的 Stream ID。
- data
- 接收到的数据。
rtcEngine:didOccurStreamMessageErrorFromUid:streamId:error:missed:cached:
接收对方数据流消息发生错误的回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine
didOccurStreamMessageErrorFromUid:(NSUInteger)uid
streamId:(NSInteger)streamId
error:(NSInteger)error
missed:(NSInteger)missed
cached:(NSInteger)cached;
详情
该回调表示本地用户未收到远端用户调用 sendStreamMessage:data: 方法发送的流消息。
参数
- engine
- AgoraRtcEngineKit 对象。
- uid
- 发送消息的用户 ID。
- streamId
- 接收到的消息的 Stream ID。
- error
- 错误码。详见 错误码。
- missed
- 丢失的消息数量。
- cached
- 数据流中断时，后面缓存的消息数量。