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