数据流 Datastream
createDataStream [1/2]
创建一个数据流。
virtual int createDataStream(int* streamId, bool reliable, bool ordered) = 0;
调用时机
你可以在加入频道前或后调用此方法。
相关回调
成功调用该方法后，如果接收端在五秒内未收到数据，SDK 会触发 onStreamMessageError 回调并返回错误码。
参数
- streamId
- 输出参数，创建的数据流 ID。
- reliable
- 是否保证接收端在五秒内收到数据流：
- true：接收端会在五秒内收到发送方的数据。如果未收到，SDK 会触发 onStreamMessageError 回调并返回错误码。
- false：不保证接收端在五秒内收到数据，延迟或丢失不会返回错误信息。
reliable和ordered同时为 true 或同时为 false。 - ordered
- 是否按发送顺序接收数据流：
- true：接收端按发送顺序接收数据。
- false：接收端不按发送顺序接收数据。
返回值
- 0：方法调用成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
createDataStream [2/2]
创建一个数据流。
virtual int createDataStream(int* streamId, const DataStreamConfig& config) = 0;
该方法不保证数据传输的可靠性。如果数据包在发送后五秒内未被接收，SDK 会直接丢弃该数据包。与 createDataStream 方法相比，该方法适用于对实时性要求高但可容忍部分数据丢失的场景。
调用时机
你可以在加入频道前或加入频道后调用该方法。
参数
- streamId
- 输出参数，创建的数据流 ID。
- config
- 数据流的配置。详见 DataStreamConfig。
返回值
- 0：方法调用成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
createDataStreamEx [1/2]
创建一个数据流。
virtual int createDataStreamEx(int* streamId, bool reliable, bool ordered, const RtcConnection& connection) = 0;
适用场景
该方法适用于多频道场景。
调用时机
在调用 joinChannelEx 后调用该方法。
相关回调
成功调用该方法后，如果设置 reliable 为 true，接收端在五秒内未收到数据，SDK 会触发 onStreamMessageError 回调并返回错误码。
参数
- streamId
- 输出参数，创建的数据流 ID。
- reliable
- 是否保证接收端在五秒内收到数据流：
- true：接收端会在五秒内收到发送方的数据。如果未收到，SDK 会触发 onStreamMessageError 回调并返回错误码。
- false：不保证接收端在五秒内收到数据流，延迟或丢失不会返回错误信息。
reliable和ordered同时为 true 或同时为 false。 - ordered
- 是否按发送顺序接收数据流：
- true：接收端按发送顺序接收数据。
- false：接收端不按发送顺序接收数据。
- connection
- 连接信息。详见 RtcConnection。
返回值
- 0：方法调用成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
createDataStreamEx [2/2]
创建一个数据流。
virtual int createDataStreamEx(int* streamId, const DataStreamConfig& config, const RtcConnection& connection) = 0;
createDataStreamEx [2/2] 与 createDataStreamEx [1/2] 相比，不保证数据传输的可靠性。如果数据包在发送后五秒内未被接收，SDK 会直接丢弃该数据。建议在调用 joinChannelEx 后调用此方法。
适用场景
该方法适用于多频道场景。
调用时机
在调用 joinChannelEx 后调用。
参数
- streamId
- 输出参数，创建的数据流 ID。
- config
- 数据流的配置。详见 DataStreamConfig。
- connection
- 连接信息。详见 RtcConnection。
返回值
- 0：方法调用成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
sendStreamMessage
发送数据流消息。
virtual int sendStreamMessage(int streamId, const char* data, size_t length) = 0;
调用 createDataStream 后，可以调用该方法向频道内的所有用户发送数据流消息。
- 如果你需要一个更全面的解决方案，以实现低延迟、高并发和可扩展的实时消息传递和状态同步，建议使用实时消息。
- 该方法需在调用
createDataStream并加入频道后调用。 - 该方法仅适用于主播角色。
相关回调
成功调用该方法后，SDK 会触发 onStreamMessage 回调，远端用户可通过该回调接收数据流消息。调用失败时，SDK 会触发远端的 onStreamMessageError 回调。
参数
- streamId
- 数据流 ID，通过调用
createDataStream获取。 - data
- 要发送的消息内容。
- length
- 数据内容的长度。
返回值
- 0：方法调用成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
sendStreamMessageEx
发送数据流消息。
virtual int sendStreamMessageEx(int streamId, const char* data, size_t length, const RtcConnection& connection) = 0;
createDataStreamEx 创建数据通道后，可以调用该方法向频道内的所有用户发送数据流消息。SDK 对该方法有限制： - 每个客户端在频道中最多可同时拥有 5 个数据通道，所有数据通道共享的总包比特率上限为 30 KB/s；
- 每个数据通道每秒最多可发送 60 个数据包，每个数据包最大为 1 KB。
- 如果你需要一个更全面的解决方案来实现低延迟、高并发和可扩展的实时消息传递和状态同步，建议使用实时消息。
- 请在调用 joinChannelEx 后再调用该方法。
- 请确保在调用该方法前已通过
createDataStreamEx创建数据通道。
适用场景
该方法适用于多频道场景。
相关回调
成功调用该方法后，SDK 会触发远端客户端的 onStreamMessage 回调，远端用户可通过该回调获取数据流消息。调用失败时，SDK 会触发远端客户端的 onStreamMessageError 回调。
参数
- streamId
- 数据流 ID，通过调用
createDataStreamEx获取。 - data
- 要发送的消息内容。
- length
- 数据长度。
- connection
- 连接信息。详见 RtcConnection。
返回值
- 0：方法调用成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
onStreamMessage
onStreamMessage 回调：远端用户发送数据流时触发。
virtual void onStreamMessage(uid_t uid, int streamId, const char* data, size_t length, uint64_t sentTs)
当本地用户收到远端用户通过调用 sendStreamMessage 发送的数据流时，SDK 会触发该回调。
参数
- uid
- 发送该数据流的远端用户 ID。
- streamId
- 接收到的数据流 ID。
- data
- 接收到的数据内容。
- length
- 接收到的数据长度（字节）。
- sentTs
- 发送该数据流的时间戳。
onStreamMessageError
本地用户未收到远端用户发送的数据流消息时触发的回调。
virtual void onStreamMessageError(uid_t uid, int streamId, int code, int missed, int cached)
该回调在本地用户未能接收到远端用户通过调用 sendStreamMessage 发送的流消息时触发。
参数
- uid
- 发送消息的远端用户 ID。
- streamId
- 接收消息对应的数据流 ID。
- code
- 错误码。
- missed
- 丢失的消息数量。
- cached
- 数据流中断期间接收到的缓存消息数量。