数据流 Datastream
createDataStream
创建数据流。
TypeScript
abstract createDataStream(config: DataStreamConfig): number;
调用时机
该方法在加入频道前后均可调用。
调用限制
在 IRtcEngine 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
参数
- config
- 数据流设置。详见 DataStreamConfig。
返回值
- 创建的数据流的 ID：方法调用成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
createDataStreamEx
创建数据流。
TypeScript
abstract createDataStreamEx(
config: DataStreamConfig,
connection: RtcConnection
): number;
调用时机
该方法需要在 joinChannelEx 后调用。
调用限制
在 IRtcEngine 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
参数
- config
- 数据流设置。详见 DataStreamConfig。
- connection
- Connection 信息。详见 RtcConnection。
返回值
- 创建的数据流的 ID：方法调用成功。
- < 0：方法调用失败。详见错误码了解详情和解决建议。
sendStreamMessage
发送数据流。
TypeScript
abstract sendStreamMessage(streamId: number, data: Uint8Array, length: number): number;
详情
调用 createDataStream 后，你可以调用该方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制：
- 频道内每个客户端最多可以同时拥有 5 个数据通道，所有数据通道共用的总发包码率限制为 30 KB/s。
- 每个数据通道每秒最多能发送 60 个包，每个包最大为 1 KB。
成功调用该方法后，远端会触发 onStreamMessage 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 onStreamMessageError 回调。
注意
- 该方法需要在加入频道后、且调用 createDataStream 创建数据通道之后调用。
- 直播场景下，该方法仅适用于主播用户。
参数
- streamId
- 数据流 ID。可以通过 createDataStream 获取。
- data
- 待发送的数据。
- length
- 数据长度。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
sendStreamMessageEx
发送数据流。
TypeScript
abstract sendStreamMessageEx(streamId: number, data: Uint8Array, length: number, connection: RtcConnection): number;
详情
调用 createDataStreamEx 后，你可以调用本方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制：
- 频道内每个客户端最多可以同时拥有 5 个数据通道，所有数据通道共用的总发包码率限制为 30 KB/s。
- 每个数据通道每秒最多能发送 60 个包，每个包最大为 1 KB。
成功调用该方法后，远端会触发 onStreamMessage 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 onStreamMessageError 回调。
注意
- 该方法需要在 joinChannelEx 后调用。
- 请确保在调用该方法前，已调用 createDataStreamEx 创建了数据通道。
- 该方法仅适用于通信场景以及直播场景下的主播用户，如果直播场景下的观众调用此方法可能会造成观众变主播。
参数
- streamId
- 数据流 ID。可以通过 createDataStreamEx 获取。
- data
- 待发送的数据。
- length
- 数据长度。
- connection
- Connection 信息。详见 RtcConnection。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
onStreamMessage
接收到对方数据流消息的回调。
TypeScript
onStreamMessage?(
connection: RtcConnection,
remoteUid: number,
streamId: number,
data: Uint8Array,
length: number,
sentTs: number
): void;
详情
该回调表示本地用户收到了远端用户调用 sendStreamMessage 方法发送的流消息。
参数
- connection
- Connection 信息。详见 RtcConnection。
- remoteUid
- 发送消息的用户 ID。
- streamId
- 接收到的消息的 Stream ID。
- data
- 接收到的数据。
- length
- 数据长度，单位为字节。
- sentTs
- 数据流发出的时间。
onStreamMessageError
接收对方数据流消息发生错误的回调。
TypeScript
onStreamMessageError?(
connection: RtcConnection,
remoteUid: number,
streamId: number,
code: ErrorCodeType,
missed: number,
cached: number
): void;
详情
该回调表示本地用户未收到远端用户调用 sendStreamMessage 方法发送的流消息。
参数
- connection
- Connection 信息。详见 RtcConnection。
- uid
- remoteUid
- 发送消息的用户 ID。
- streamId
- 接收到的消息的 Stream ID。
- code
- 错误码。详见 ErrorCodeType。
- missed
- 丢失的消息数量。
- cached
- 数据流中断时，后面缓存的消息数量。