需要访问旧版文档站？前往旧版文档官网首页。 (在新标签页打开)
声网文档中心

数据流 Datastream

  • C#

更新时间不可用

CreateDataStream [1/2]

创建数据流。

C#
public abstract int CreateDataStream(ref int streamId, bool reliable, bool ordered);

你可以调用该方法创建数据流并提高数据传输的可靠性和有序性。

调用时机

该方法在加入频道前后均可调用。

调用限制

在 IRtcEngine 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。

相关回调

将 reliable 设置为 true 后，如果接收方 5 秒没有收到发送方所发送的数据，会触发 OnStreamMessageError 回调并获得相应报错信息。

参数

参数名描述
streamId

输出参数，创建好的数据流 ID。

reliable

是否保证数据可靠性，即接收方是否需要在数据发送后的 5 秒内接收：

  • true: 接收方 5 秒内会收到发送方所发送的数据，否则会收到 OnStreamMessageError 回调并获得相应报错信息。
  • false: 接收方不保证收到，就算数据丢失也不会报错。

注意： 请确保将 reliable 和 ordered 同时设为 true 或同时设为 false。

ordered

是否保证数据有序性，即接收方是否需要收到有序的数据：

  • true: 接收方会按照发送方发送的顺序收到数据包。
  • false: 接收方不保证按照发送方发送的顺序收到数据包。
表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 创建数据流成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

CreateDataStreamEx [1/2]

创建数据流。

C#
public abstract int CreateDataStreamEx(ref int streamId, bool reliable, bool ordered, RtcConnection connection);

弃用：

该方法已废弃。请改用 CreateDataStreamEx [2/2]。

你可以调用该方法创建数据流并提高数据传输的可靠性和有序性。

调用时机

该方法需要在 JoinChannelEx 后调用。

调用限制

在 IRtcEngine 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。

相关回调

将 reliable 设置为 true 后，如果接收方 5 秒没有收到发送方所发送的数据，会触发 OnStreamMessageError 回调并获得相应报错信息。

参数

参数名描述
streamId

输出参数，创建好的数据流 ID。

reliable

是否保证数据可靠性，即接收方是否需要在数据发送后的 5 秒内接收：

  • true: 接收方 5 秒内会收到发送方所发送的数据，否则会收到 OnStreamMessageError 回调并获得相应报错信息。
  • false: 接收方不保证收到，就算数据丢失也不会报错。

注意： 请确保将 reliable 和 ordered 同时设为 true 或同时设为 false。

ordered

是否保证数据有序性，即接收方是否需要收到有序的数据：

  • true: 接收方会按照发送方发送的顺序收到数据包。
  • false: 接收方不保证按照发送方发送的顺序收到数据包。
connection

Connection 信息。详见 RtcConnection。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 创建数据流成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

CreateDataStream [2/2]

创建数据流。

C#
public abstract int CreateDataStream(ref int streamId, DataStreamConfig config);

相比 CreateDataStream [1/2]，本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。

调用时机

该方法在加入频道前后均可调用。

调用限制

在 IRtcEngine 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。

参数

参数名描述
streamId

输出参数，创建好的数据流 ID。

config

数据流设置。详见 DataStreamConfig。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 创建数据流成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

CreateDataStreamEx [2/2]

创建数据流。

C#
public abstract int CreateDataStreamEx(ref int streamId, DataStreamConfig config, RtcConnection connection);

相比 CreateDataStreamEx [1/2]，本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。

调用时机

该方法需要在 JoinChannelEx 后调用。

调用限制

在 IRtcEngine 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。

参数

参数名描述
streamId

输出参数，创建好的数据流 ID。

config

数据流设置。详见 DataStreamConfig。

connection

Connection 信息。详见 RtcConnection。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 创建数据流成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

所属接口类

SendMetadata

发送媒体附属信息。

C#
public abstract int SendMetadata(Metadata metadata, VIDEO_SOURCE_TYPE source_type);

详情

如果成功发送了媒体附属信息，接收端会收到 OnMetadataReceived 回调。

参数

参数名描述
metadata

媒体附属信息。详见 Metadata。

视频源的类型，详见 VIDEO_SOURCE_TYPE。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

SetMaxMetadataSize

设置媒体附属信息的最大大小。

C#
public abstract int SetMaxMetadataSize(int size);

详情

调用 RegisterMediaMetadataObserver 后，你可以调用本方法来设置媒体附属信息的最大大小。

参数

参数名描述
size

媒体附属信息的最大大小。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0：方法调用成功。
  • < 0：方法调用失败。详见错误码了解详情和解决建议。

SendStreamMessage

发送数据流。

C#
public abstract int SendStreamMessage(int streamId, byte[] data, uint length);

详情

调用 CreateDataStream [2/2] 后，你可以调用该方法向频道内所有用户发送数据流消息。

SDK 对该方法的实现进行了如下限制：

  • 频道内每个客户端最多可以同时拥有 5 个数据通道，所有数据通道共用的总发包码率限制为 30 KB/s。
  • 每个数据通道每秒最多能发送 60 个包，每个包最大为 1 KB。

成功调用该方法后，远端会触发 OnStreamMessage 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 OnStreamMessageError 回调。

注意：

  • 该方法需要在加入频道后、且调用 CreateDataStream [2/2] 创建数据通道之后调用。
  • 该方法仅适用于主播用户。

参数

参数名描述
streamId

数据流 ID。可以通过 CreateDataStream [2/2] 获取。

data

待发送的数据。

length

数据长度。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

SendStreamMessageEx

发送数据流。

C#
public abstract int SendStreamMessageEx(int streamId, byte[] data, uint length, RtcConnection connection);

详情

调用 CreateDataStreamEx [2/2] 后，你可以调用本方法向频道内所有用户发送数据流消息。

SDK 对该方法的实现进行了如下限制：

  • 频道内每个客户端最多可以同时拥有 5 个数据通道，所有数据通道共用的总发包码率限制为 30 KB/s。
  • 每个数据通道每秒最多能发送 60 个包，每个包最大为 1 KB。

成功调用该方法后，远端会触发 OnStreamMessage 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 OnStreamMessageError 回调。

注意：

  • 该方法需要在 JoinChannelEx 后调用。
  • 请确保在调用该方法前，已调用 CreateDataStreamEx [2/2] 创建了数据通道。

参数

参数名描述
streamId

数据流 ID。可以通过 CreateDataStreamEx [2/2] 获取。

data

待发送的数据。

length

数据长度。

connection

Connection 信息。详见 RtcConnection。

表格内容超出当前宽度，可横向滚动查看更多列。

返回值

  • 0: 方法调用成功。
  • < 0: 方法调用失败。详见错误码了解详情和解决建议。

所属接口类

OnStreamMessage

接收到对方数据流消息的回调。

C#
public virtual void OnStreamMessage(RtcConnection connection, uint remoteUid, int streamId, byte[] data, ulong length, ulong sentTs) { }

详情

该回调表示本地用户收到了远端用户调用 SendStreamMessage 方法发送的流消息。

参数

参数名描述
connection

Connection 信息。详见 RtcConnection。

remoteUid

发送消息的用户 ID。

streamId

接收到的消息的 Stream ID。

data

接收到的数据。

length

数据长度，单位为字节。

sentTs

数据流发出的时间。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

OnStreamMessageError

接收对方数据流消息发生错误的回调。

C#
public virtual void OnStreamMessageError(RtcConnection connection, uint remoteUid, int streamId, int code, int missed, int cached) {}

详情

该回调表示本地用户未收到远端用户调用 SendStreamMessage 方法发送的流消息。

参数

参数名描述
connection

Connection 信息。详见 RtcConnection。

remoteUid

发送消息的用户 ID。

streamId

接收到的消息的 Stream ID。

code

错误码。详见 。

missed

丢失的消息数量。

cached

数据流中断时，后面缓存的消息数量。

表格内容超出当前宽度，可横向滚动查看更多列。

所属接口类

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利