# 数据流 Datastream (/zh-CN/api-reference/rtc/unity/metadata/datastream)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="toc_datastream"></a>

<a id="api_irtcengine_createdatastream1"></a>

<a id="ariaid-title2"></a>

## CreateDataStream [1/2] [#createdatastream-12]

创建数据流。

<a id="api_irtcengine_createdatastream1__prototype"></a>

```csharp
public abstract int CreateDataStream(ref int streamId, bool reliable, bool ordered);
```

<a id="api_irtcengine_createdatastream1__detailed_desc"></a>

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

:::note
注： 如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案，推荐使用实时消息。
在 [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine) 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
:::

<a id="api_irtcengine_createdatastream1__timing"></a>

### 调用时机 [#调用时机]

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

<a id="api_irtcengine_createdatastream1__related"></a>

### 相关回调 [#相关回调]

将 `reliable` 设置为 true 后，如果接收方 5 秒没有收到发送方所发送的数据，会触发 [OnStreamMessageError](/zh-CN/api-reference/rtc/unity/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调并获得相应报错信息。

<a id="api_irtcengine_createdatastream1__parameters"></a>

### 参数 [#参数]

<ParameterList>
<a id="streamid"></a>
<Parameter name="streamId">

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

</Parameter>
<a id="reliable"></a>
<Parameter name="reliable">

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

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

- true: 接收方 5 秒内会收到发送方所发送的数据，否则会收到 [OnStreamMessageError](/zh-CN/api-reference/rtc/unity/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调并获得相应报错信息。
- false: 接收方不保证收到，就算数据丢失也不会报错。

</Parameter>
<a id="ordered"></a>
<Parameter name="ordered">

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

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

</Parameter>
</ParameterList>

<a id="api_irtcengine_createdatastream1__return_values"></a>

### 返回值 [#返回值]

- 0: 创建数据流成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类]

- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)

<a id="api_irtcengine_createdatastream2"></a>

<a id="ariaid-title3"></a>

## CreateDataStream [2/2] [#createdatastream-22]

创建数据流。

<a id="api_irtcengine_createdatastream2__prototype"></a>

```csharp
public abstract int CreateDataStream(ref int streamId, DataStreamConfig config);
```

<a id="api_irtcengine_createdatastream2__detailed_desc"></a>

相比 [CreateDataStream [1/2]](/zh-CN/api-reference/rtc/unity/metadata/datastream#api_irtcengine_createdatastream1)，本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。

:::note
注： 如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案，推荐使用实时消息。
在 [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine) 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
:::

<a id="api_irtcengine_createdatastream2__timing"></a>

### 调用时机 [#调用时机-1]

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

<a id="api_irtcengine_createdatastream2__parameters"></a>

### 参数 [#参数-1]

<ParameterList>
<a id="streamid-1"></a>
<Parameter name="streamId">

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

</Parameter>
<a id="config"></a>
<Parameter name="config">

数据流设置。详见 [DataStreamConfig](/zh-CN/api-reference/rtc/unity/class-datastreamconfig)。

</Parameter>
</ParameterList>

<a id="api_irtcengine_createdatastream2__return_values"></a>

### 返回值 [#返回值-1]

- 0: 创建数据流成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-1]

- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_createdatastreamex1"></a>

<a id="ariaid-title4"></a>

## CreateDataStreamEx [1/2] [#createdatastreamex-12]

创建数据流。

<a id="api_irtcengineex_createdatastreamex1__prototype"></a>

```csharp
public abstract int CreateDataStreamEx(ref int streamId, bool reliable, bool ordered, RtcConnection connection);
```

<a id="api_irtcengineex_createdatastreamex1__detailed_desc"></a>

<a id="废弃"></a>

:::error[废弃]
弃用： 该方法已废弃。请改用 [CreateDataStreamEx [2/2]](/zh-CN/api-reference/rtc/unity/metadata/datastream#api_irtcengineex_createdatastreamex2)。
:::

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

:::note
注： 在 [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine) 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
:::

<a id="api_irtcengineex_createdatastreamex1__timing"></a>

### 调用时机 [#调用时机-2]

该方法需要在 [JoinChannelEx](/zh-CN/api-reference/rtc/unity/channel#api_irtcengineex_joinchannelex) 后调用。

<a id="api_irtcengineex_createdatastreamex1__related"></a>

### 相关回调 [#相关回调-1]

将 `reliable` 设置为 true 后，如果接收方 5 秒没有收到发送方所发送的数据，会触发 [OnStreamMessageError](/zh-CN/api-reference/rtc/unity/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调并获得相应报错信息。

<a id="api_irtcengineex_createdatastreamex1__parameters"></a>

### 参数 [#参数-2]

<ParameterList>
<a id="streamid-2"></a>
<Parameter name="streamId">

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

</Parameter>
<a id="reliable-1"></a>
<Parameter name="reliable">

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

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

- true: 接收方 5 秒内会收到发送方所发送的数据，否则会收到 [OnStreamMessageError](/zh-CN/api-reference/rtc/unity/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调并获得相应报错信息。
- false: 接收方不保证收到，就算数据丢失也不会报错。

</Parameter>
<a id="ordered-1"></a>
<Parameter name="ordered">

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

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

</Parameter>
<a id="connection"></a>
<Parameter name="connection">

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_createdatastreamex1__return_values"></a>

### 返回值 [#返回值-2]

- 0: 创建数据流成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-2]

- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengineex_createdatastreamex2"></a>

<a id="ariaid-title5"></a>

## CreateDataStreamEx [2/2] [#createdatastreamex-22]

创建数据流。

<a id="api_irtcengineex_createdatastreamex2__prototype"></a>

```csharp
public abstract int CreateDataStreamEx(ref int streamId, DataStreamConfig config, RtcConnection connection);
```

<a id="api_irtcengineex_createdatastreamex2__detailed_desc"></a>

相比 [CreateDataStreamEx [1/2]](/zh-CN/api-reference/rtc/unity/metadata/datastream#api_irtcengineex_createdatastreamex1)，本方法不保证数据传输的可靠性。接收方会丢弃超出发送时间 5 秒后的数据包。

:::note
注： 如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案，推荐使用实时消息。
在 [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine) 生命周期内，每个用户最多只能创建 5 个数据流。离开频道时数据流会被销毁，如需使用需要重新创建数据流。
:::

<a id="api_irtcengineex_createdatastreamex2__timing"></a>

### 调用时机 [#调用时机-3]

该方法需要在 [JoinChannelEx](/zh-CN/api-reference/rtc/unity/channel#api_irtcengineex_joinchannelex) 后调用。

<a id="api_irtcengineex_createdatastreamex2__parameters"></a>

### 参数 [#参数-3]

<ParameterList>
<a id="streamid-3"></a>
<Parameter name="streamId">

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

</Parameter>
<a id="config-1"></a>
<Parameter name="config">

数据流设置。详见 [DataStreamConfig](/zh-CN/api-reference/rtc/unity/class-datastreamconfig)。

</Parameter>
<a id="connection-1"></a>
<Parameter name="connection">

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_createdatastreamex2__return_values"></a>

### 返回值 [#返回值-3]

- 0: 创建数据流成功。
- &lt; 0：方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-3]

- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)

<a id="api_irtcengine_sendstreammessage"></a>

<a id="ariaid-title6"></a>

## SendStreamMessage [#sendstreammessage]

发送数据流。

<a id="api_irtcengine_sendstreammessage__prototype"></a>

```csharp
public abstract int SendStreamMessage(int streamId, byte[] data, uint length);
```

<a id="api_irtcengine_sendstreammessage__detailed_desc"></a>

调用 [CreateDataStream [2/2]](/zh-CN/api-reference/rtc/unity/metadata/datastream#api_irtcengine_createdatastream2) 后，你可以调用该方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制：

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

成功调用该方法后，远端会触发 [OnStreamMessage](/zh-CN/api-reference/rtc/unity/metadata/datastream#callback_irtcengineeventhandler_onstreammessage) 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 [OnStreamMessageError](/zh-CN/api-reference/rtc/unity/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调。

:::note
注： 如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案，推荐使用实时消息。

- 该方法需要在加入频道后、且调用 [CreateDataStream [2/2]](/zh-CN/api-reference/rtc/unity/metadata/datastream#api_irtcengine_createdatastream2) 创建数据通道之后调用。
- 该方法仅适用于主播用户。
:::

<a id="api_irtcengine_sendstreammessage__parameters"></a>

### 参数 [#参数-4]

<ParameterList>
<a id="streamid-4"></a>
<Parameter name="streamId">

数据流 ID。可以通过 [CreateDataStream [2/2]](/zh-CN/api-reference/rtc/unity/metadata/datastream#api_irtcengine_createdatastream2) 获取。

</Parameter>
<a id="data"></a>
<Parameter name="data">

待发送的数据。

</Parameter>
<a id="length"></a>
<Parameter name="length">

数据长度。

</Parameter>
</ParameterList>

<a id="api_irtcengine_sendstreammessage__return_values"></a>

### 返回值 [#返回值-4]

- 0: 方法调用成功。
- &lt; 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-4]

- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)

<a id="api_irtcengineex_sendstreammessageex"></a>

<a id="ariaid-title7"></a>

## SendStreamMessageEx [#sendstreammessageex]

发送数据流。

<a id="api_irtcengineex_sendstreammessageex__prototype"></a>

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

<a id="api_irtcengineex_sendstreammessageex__detailed_desc"></a>

调用 [CreateDataStreamEx [2/2]](/zh-CN/api-reference/rtc/unity/metadata/datastream#api_irtcengineex_createdatastreamex2) 后，你可以调用本方法向频道内所有用户发送数据流消息。
SDK 对该方法的实现进行了如下限制：

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

成功调用该方法后，远端会触发 [OnStreamMessage](/zh-CN/api-reference/rtc/unity/metadata/datastream#callback_irtcengineeventhandler_onstreammessage) 回调，远端用户可以在该回调中获取接收到的流消息；若调用失败，远端会触发 [OnStreamMessageError](/zh-CN/api-reference/rtc/unity/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) 回调。

:::note
注：

- 如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案，推荐使用实时消息。
- 该方法需要在 [JoinChannelEx](/zh-CN/api-reference/rtc/unity/channel#api_irtcengineex_joinchannelex) 后调用。
- 请确保在调用该方法前，已调用 [CreateDataStreamEx [2/2]](/zh-CN/api-reference/rtc/unity/metadata/datastream#api_irtcengineex_createdatastreamex2) 创建了数据通道。
:::

<a id="api_irtcengineex_sendstreammessageex__parameters"></a>

### 参数 [#参数-5]

<ParameterList>
<a id="streamid-5"></a>
<Parameter name="streamId">

数据流 ID。可以通过 [CreateDataStreamEx [2/2]](/zh-CN/api-reference/rtc/unity/metadata/datastream#api_irtcengineex_createdatastreamex2) 获取。

</Parameter>
<a id="data-1"></a>
<Parameter name="data">

待发送的数据。

</Parameter>
<a id="length-1"></a>
<Parameter name="length">

数据长度。

</Parameter>
<a id="connection-2"></a>
<Parameter name="connection">

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。

</Parameter>
</ParameterList>

<a id="api_irtcengineex_sendstreammessageex__return_values"></a>

### 返回值 [#返回值-5]

- 0: 方法调用成功。
- &lt; 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。

### 所属接口类 [#所属接口类-5]

- [IRtcEngineEx](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineex)

<a id="callback_irtcengineeventhandler_onstreammessage"></a>

<a id="ariaid-title8"></a>

## OnStreamMessage [#onstreammessage]

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

<a id="callback_irtcengineeventhandler_onstreammessage__prototype"></a>

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

<a id="callback_irtcengineeventhandler_onstreammessage__detailed_desc"></a>

该回调表示本地用户收到了远端用户调用 [SendStreamMessage](/zh-CN/api-reference/rtc/unity/metadata/datastream#api_irtcengine_sendstreammessage) 方法发送的流消息。

:::note
注： 如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案，推荐使用实时消息。
:::

<a id="callback_irtcengineeventhandler_onstreammessage__parameters"></a>

### 参数 [#参数-6]

<ParameterList>
<a id="connection-3"></a>
<Parameter name="connection">

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。

</Parameter>
<a id="remoteuid"></a>
<Parameter name="remoteUid">

发送消息的用户 ID。

</Parameter>
<a id="streamid-6"></a>
<Parameter name="streamId">

接收到的消息的 Stream ID。

</Parameter>
<a id="data-2"></a>
<Parameter name="data">

接收到的数据。

</Parameter>
<a id="length-2"></a>
<Parameter name="length">

数据长度，单位为字节。

</Parameter>
<a id="sentts"></a>
<Parameter name="sentTs">

数据流发出的时间。

</Parameter>
</ParameterList>

### 所属接口类 [#所属接口类-6]

- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineeventhandler)

<a id="callback_irtcengineeventhandler_onstreammessageerror"></a>

<a id="ariaid-title9"></a>

## OnStreamMessageError [#onstreammessageerror]

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

<a id="callback_irtcengineeventhandler_onstreammessageerror__prototype"></a>

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

<a id="callback_irtcengineeventhandler_onstreammessageerror__detailed_desc"></a>

该回调表示本地用户未收到远端用户调用 [SendStreamMessage](/zh-CN/api-reference/rtc/unity/metadata/datastream#api_irtcengine_sendstreammessage) 方法发送的流消息。

:::note
注： 如你需要更加全面的低延时、高并发、可扩展的实时消息及状态同步解决方案，推荐使用实时消息。
:::

<a id="callback_irtcengineeventhandler_onstreammessageerror__parameters"></a>

### 参数 [#参数-7]

<ParameterList>
<a id="connection-4"></a>
<Parameter name="connection">

Connection 信息。详见 [RtcConnection](/zh-CN/api-reference/rtc/unity/class-rtcconnection)。

</Parameter>
<a id="remoteuid-1"></a>
<Parameter name="remoteUid">

发送消息的用户 ID。

</Parameter>
<a id="streamid-7"></a>
<Parameter name="streamId">

接收到的消息的 Stream ID。

</Parameter>
<a id="code"></a>
<Parameter name="code">

错误码。详见 [错误码](/zh-CN/api-reference/rtc/error-code)。

</Parameter>
<a id="missed"></a>
<Parameter name="missed">

丢失的消息数量。

</Parameter>
<a id="cached"></a>
<Parameter name="cached">

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

</Parameter>
</ParameterList>

### 所属接口类 [#所属接口类-7]

- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineeventhandler)