数据流 Datastream
createDataStream
createDataStreamEx
创建数据流。
ArkTS
public abstract createDataStreamEx(config:DataStreamConfig,connection:RtcConnection):number;
调用时机
该方法需要在 joinChannelEx 后调用。
调用限制
在 RtcEngine 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
参数
- config
- 数据流设置。详见 DataStreamConfig。
- connection
- Connection 信息。详见 RtcConnection。
返回值
- 创建的数据流的 ID：方法调用成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
sendStreamMessage
发送数据流。
ArkTS
public abstract sendStreamMessage(streamId: number, message: ArrayBuffer): number;
详情
调用 createDataStream 后，你可以调用该方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制：
- 频道内每人最多能同时有 5 个数据通道。
- 每个数据通道每秒最多能发送 60 个包（每个包最大为 1 KB）。
- 每个数据通道每秒最多能发送 30 KB 数据。
成功调用该方法后，远端会触发 onStreamMessage 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 onStreamMessageError 回调。
注意
- 该方法需要在加入频道后、且调用 createDataStream 创建数据通道之后调用。
- 直播场景下，该方法仅适用于主播用户。
参数
- streamId
- 数据流 ID。可以通过 createDataStream 获取。
- message
- 待发送的数据。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
onStreamMessage
接收到对方数据流消息的回调。
ArkTS
onStreamMessage?:(uid:number, streamId:number,data:Uint8Array) => void;
详情
该回调表示本地用户收到了远端用户调用 sendStreamMessage 方法发送的流消息。
参数
- uid
- 发送消息的用户 ID。
- streamId
- 接收到的消息的 Stream ID。
- data
- 接收到的数据。
onStreamMessageError
接收对方数据流消息发生错误的回调。
ArkTS
onStreamMessageError? : (uid:number,streamId:number,error:number,missed:number,cached:number) => void;
详情
该回调表示本地用户未收到远端用户调用 sendStreamMessage 方法发送的流消息。
参数
- uid
- 发送消息的用户 ID。
- streamId
- 接收到的消息的 Stream ID。
- error
- 错误码。详见 错误码。
- missed
- 丢失的消息数量。
- cached
- 数据流中断时，后面缓存的消息数量。