数据流 Datastream
创建数据流。
你可以调用该方法创建数据流并提高数据传输的可靠性和有序性。
调用时机
该方法需要在加入频道后调用。
调用限制
在 RtcEngine 生命周期内,每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁,如需使用需要重新创建数据流。
相关回调
将 reliable 设置为 true
后,如果接收方 5 秒没有收到发送方所发送的数据,会触发 onStreamMessageError 回调并获得相应报错信息。
参数
- reliable
- 是否保证数据可靠性,即接收方是否需要在数据发送后的 5 秒内接收:
true
: 接收方 5 秒内会收到发送方所发送的数据,否则会收到 onStreamMessageError 回调并获得相应报错信息。false
: 接收方不保证收到,就算数据丢失也不会报错。
注意请确保将 reliable 和 ordered 同时设为true
或同时设为false
。 - ordered
- 是否保证数据有序性,即接收方是否需要收到有序的数据:
true
: 接收方会按照发送方发送的顺序收到数据包。false
: 接收方不保证按照发送方发送的顺序收到数据包。
返回值
- 创建的数据流的 ID:方法调用成功。
- < 0:方法调用失败。详见错误码了解详情和解决建议。
createDataStream
创建数据流。
public abstract createDataStream(config: DataStreamConfig): number;
相比 toc_datastream.html#api_irtcengine_createdatastream,本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。
调用时机
该方法需要在加入频道后调用。
调用限制
在 RtcEngine 生命周期内,每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁,如需使用需要重新创建数据流。
参数
- config
- 数据流设置。详见 DataStreamConfig。
返回值
- 创建的数据流的 ID:方法调用成功。
- < 0:方法调用失败。详见错误码了解详情和解决建议。
createDataStreamEx [1/2]
创建数据流。
public abstract createDataStreamEx(config:DataStreamConfig,connection:RtcConnection):number;
你可以调用该方法创建数据流并提高数据传输的可靠性和有序性。
调用时机
该方法需要在调用 joinChannelEx 加入频道后调用。
调用限制
在 RtcEngine 生命周期内,每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁,如需使用需要重新创建数据流。
相关回调
将 reliable 设置为 true
后,如果接收方 5 秒没有收到发送方所发送的数据,会触发 onStreamMessageError 回调并获得相应报错信息。
参数
- reliable
- 是否保证数据可靠性,即接收方是否需要在数据发送后的 5 秒内接收:
true
: 接收方 5 秒内会收到发送方所发送的数据,否则会收到 onStreamMessageError 回调并获得相应报错信息。false
: 接收方不保证收到,就算数据丢失也不会报错。
注意请确保将 reliable 和 ordered 同时设为true
或同时设为false
。 - ordered
- 是否保证数据有序性,即接收方是否需要收到有序的数据:
true
: 接收方会按照发送方发送的顺序收到数据包。false
: 接收方不保证按照发送方发送的顺序收到数据包。
- connection
- Connection 信息。详见 RtcConnection。
返回值
- 创建的数据流的 ID:方法调用成功。
- < 0:方法调用失败。详见错误码了解详情和解决建议。
createDataStreamEx
创建数据流。
public abstract createDataStreamEx(config:DataStreamConfig,connection:RtcConnection):number;
相比 createDataStreamEx [1/2],本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。
调用时机
该方法需要在调用 joinChannelEx 加入频道后调用。
调用限制
在 RtcEngine 生命周期内,每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁,如需使用需要重新创建数据流。
参数
- config
- 数据流设置。详见 DataStreamConfig。
- connection
- Connection 信息。详见 RtcConnection。
返回值
- 创建的数据流的 ID:方法调用成功。
- < 0:方法调用失败。详见错误码了解详情和解决建议。
sendStreamMessage
发送数据流。
public abstract sendStreamMessage(streamId: number, message: ArrayBuffer): number;
详情
- 频道内每秒最多能发送 30 个包,且每个包最大为 1 KB。
- 每个客户端每秒最多能发送 6 KB 数据。
- 频道内每人最多能同时有 5 个数据通道。
成功调用该方法后,远端会触发 onStreamMessage 回调,远端用户可以在该回调中获取接收到的流消息; 若调用失败,远端会触发 onStreamMessageError 回调。
- 请确保在调用该方法前,已调用 createDataStream 创建了数据通道。
- 直播场景下,该方法仅适用于主播用户。
参数
- streamId
- 数据流 ID。可以通过 createDataStream 获取。
- message
- 待发送的数据。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
onStreamMessage
接收到对方数据流消息的回调。
onStreamMessage?:(uid:number, streamId:number,data:Uint8Array) => void;
详情
该回调表示本地用户收到了远端用户调用 sendStreamMessage 方法发送的流消息。
参数
- streamId
- 接收到的消息的 Stream ID。
- data
- 接收到的数据。
onStreamMessageError
接收对方数据流消息发生错误的回调。
onStreamMessageError? : (uid:number,streamId:number,error:number,missed:number,cached:number) => void;
详情
该回调表示本地用户未收到远端用户调用 sendStreamMessage 方法发送的流消息。
参数
- streamId
- 接收到的消息的 Stream ID。发生错误的错误码。详见 错误码。
- missed
- 丢失的消息数量。
- cached
- 数据流中断时,后面缓存的消息数量。