数据流 Datastream
- Unreal C++
更新时间不可用
createDataStream [1/2]
创建数据流。
virtual int createDataStream(int* streamId, bool reliable, bool ordered) = 0;你可以调用该方法创建数据流并提高数据传输的可靠性和有序性。
调用时机
该方法在加入频道前后均可调用。
调用限制
在 IRtcEngine 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
相关回调
将 reliable 设置为 true 后，如果接收方 5 秒没有收到发送方所发送的数据，会触发 onStreamMessageError 回调并获得相应报错信息。
参数
| 参数名 | 描述 |
|---|---|
streamId | |
reliable | |
ordered |
返回值
- 0: 创建数据流成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
所属接口类
createDataStreamEx [1/2]
创建数据流。
virtual int createDataStreamEx(int* streamId, bool reliable, bool ordered, const RtcConnection& connection) = 0;弃用：
该方法已废弃。请改用 createDataStreamEx [2/2]。
你可以调用该方法创建数据流并提高数据传输的可靠性和有序性。
调用时机
该方法需要在 joinChannelEx 后调用。
调用限制
在 IRtcEngine 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
相关回调
将 reliable 设置为 true 后，如果接收方 5 秒没有收到发送方所发送的数据，会触发 onStreamMessageError 回调并获得相应报错信息。
参数
| 参数名 | 描述 |
|---|---|
streamId | |
reliable | |
ordered | |
connection | Connection 信息。详见 RtcConnection。 |
返回值
- 0: 创建数据流成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
所属接口类
createDataStream [2/2]
创建数据流。
virtual int createDataStream(int* streamId, DataStreamConfig& config) = 0;相比 createDataStream [1/2]，本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。
调用时机
该方法在加入频道前后均可调用。
调用限制
在 IRtcEngine 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
参数
| 参数名 | 描述 |
|---|---|
streamId | |
config | 数据流设置。详见 DataStreamConfig。 |
返回值
- 0: 创建数据流成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
所属接口类
createDataStreamEx [2/2]
创建数据流。
virtual int createDataStreamEx(int* streamId, DataStreamConfig& config, const RtcConnection& connection) = 0;相比 createDataStreamEx [1/2]，本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。
调用时机
该方法需要在 joinChannelEx 后调用。
调用限制
在 IRtcEngine 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
参数
| 参数名 | 描述 |
|---|---|
streamId | |
config | 数据流设置。详见 DataStreamConfig。 |
connection | Connection 信息。详见 RtcConnection。 |
返回值
- 0: 创建数据流成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
所属接口类
sendStreamMessage
发送数据流。
virtual int sendStreamMessage(int streamId,
const char* data,
size_t length) = 0;详情
调用 createDataStream [2/2] 后，你可以调用该方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制：
- 频道内每个客户端最多可以同时拥有 5 个数据通道，所有数据通道共用的总发包码率限制为 30 KB/s。
- 每个数据通道每秒最多能发送 60 个包，每个包最大为 1 KB。
成功调用该方法后，远端会触发 onStreamMessage 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 onStreamMessageError 回调。
注意：
- 该方法需要在加入频道后、且调用 createDataStream [2/2] 创建数据通道之后调用。
- 该方法仅适用于主播用户。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
sendStreamMessageEx
发送数据流。
virtual int sendStreamMessageEx(int streamId, const char* data, size_t length, const RtcConnection& connection) = 0;详情
调用 createDataStreamEx [2/2] 后，你可以调用本方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制：
- 频道内每个客户端最多可以同时拥有 5 个数据通道，所有数据通道共用的总发包码率限制为 30 KB/s。
- 每个数据通道每秒最多能发送 60 个包，每个包最大为 1 KB。
成功调用该方法后，远端会触发 onStreamMessage 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 onStreamMessageError 回调。
注意：
- 该方法需要在 joinChannelEx 后调用。
- 请确保在调用该方法前，已调用 createDataStreamEx [2/2] 创建了数据通道。
参数
| 参数名 | 描述 |
|---|---|
streamId | |
data | |
length | |
connection | Connection 信息。详见 RtcConnection。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
onStreamMessage
接收到对方数据流消息的回调。
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;
}详情
该回调表示本地用户收到了远端用户调用 sendStreamMessage 方法发送的流消息。
参数
所属接口类
onStreamMessageError
接收对方数据流消息发生错误的回调。
virtual void onStreamMessageError(uid_t userId, int streamId, int code, int missed, int cached) {
(void)userId;
(void)streamId;
(void)code;
(void)missed;
(void)cached;
}
详情
该回调表示本地用户未收到远端用户调用 sendStreamMessage 方法发送的流消息。
参数
| 参数名 | 描述 |
|---|---|
userId | |
streamId | |
code | 错误码。详见 错误码。 |
missed | |
cached |