数据流 Datastream
- Unreal Blueprint
更新时间不可用
CreateDataStream
创建数据流。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int CreateDataStream(int& streamId, const FDataStreamConfig& config);调用时机
该方法在加入频道前后均可调用。
调用限制
在 IRtcEngine 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
参数
| 参数名 | 描述 |
|---|---|
streamId | |
config | 数据流设置。详见 FDataStreamConfig。 |
返回值
- 0: 创建数据流成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
所属接口类
CreateDataStreamEx
创建数据流。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int CreateDataStreamEx(int& streamId, const FDataStreamConfig& config, const FRtcConnection& connection);调用时机
该方法需要在 JoinChannelEx 后调用。
调用限制
在 IRtcEngine 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
参数
| 参数名 | 描述 |
|---|---|
streamId | |
config | 数据流设置。详见 FDataStreamConfig。 |
connection | Connection 信息。详见 FUABT_RtcConnection。 |
返回值
- 0: 创建数据流成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
所属接口类
SendStreamMessage
发送数据流。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SendStreamMessage(int streamId, const FString& data);详情
调用 CreateDataStream 后，你可以调用该方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制：
- 频道内每个客户端最多可以同时拥有 5 个数据通道，所有数据通道共用的总发包码率限制为 30 KB/s。
- 每个数据通道每秒最多能发送 60 个包，每个包最大为 1 KB。
成功调用该方法后，远端会触发 OnStreamMessage 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 OnStreamMessageError 回调。
注意：
- 该方法需要在加入频道后、且调用 CreateDataStream 创建数据通道之后调用。
- 该方法仅适用于主播用户。
参数
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
SendStreamMessageEx
发送数据流。
UFUNCTION(BlueprintCallable, Category = "Agora|IRtcEngine")
int SendStreamMessageEx(int streamId, const FString& data, const FRtcConnection& connection);详情
调用 CreateDataStreamEx 后，你可以调用本方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制：
- 频道内每个客户端最多可以同时拥有 5 个数据通道，所有数据通道共用的总发包码率限制为 30 KB/s。
- 每个数据通道每秒最多能发送 60 个包，每个包最大为 1 KB。
成功调用该方法后，远端会触发 OnStreamMessage 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 OnStreamMessageError 回调。
注意：
- 该方法需要在 JoinChannelEx 后调用。
- 请确保在调用该方法前，已调用 CreateDataStreamEx 创建了数据通道。
参数
| 参数名 | 描述 |
|---|---|
streamId | |
data | |
length | |
connection | Connection 信息。详见 FUABT_RtcConnection。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
OnStreamMessage
接收到对方数据流消息的回调。
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
void OnStreamMessage(int64 uid, int streamId, const FString& data, int length, int64 sentTs);详情
该回调表示本地用户收到了远端用户调用 SendStreamMessage 方法发送的流消息。
参数
所属接口类
OnStreamMessageError
接收对方数据流消息发生错误的回调。
UFUNCTION(BlueprintNativeEvent, Category = "Agora|Event")
void OnStreamMessageError(int64 uid, int streamId, int code, int missed, int cached);详情
该回调表示本地用户未收到远端用户调用 SendStreamMessage 方法发送的流消息。
参数
| 参数名 | 描述 |
|---|---|
userId | |
streamId | |
code | 错误码。详见 错误码。 |
missed | |
cached |